AIM Web Services

<back to all web services

EditInventoryRequest

EditInventory
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/EditInventory
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * EditInventoryRequires active-e Inventory Service
    */
    @DataContract
    public static class EditInventoryRequest extends BaseSecureRequest
    {
        @DataMember
        public Long SaqPk = null;

        @DataMember
        public Long SasPk = null;

        @DataMember
        public String Description = null;

        @DataMember
        public BigDecimal OurPrice = null;

        @DataMember
        public BigDecimal RetailPrice = null;

        @DataMember
        public BigDecimal PriceA = null;

        @DataMember
        public BigDecimal PriceB = null;

        @DataMember
        public BigDecimal PriceC = null;

        @DataMember
        public BigDecimal MinPrice = null;

        @DataMember
        public BigDecimal ActiveEPrice = null;

        @DataMember
        public String Locator = null;

        @DataMember
        public Boolean UpdateAllLocations = null;

        /**
        * List of Barcodes. If barcodes are sent, they will overwrite existing barcodes.
        */
        @DataMember
        @ApiMember(Description="List of Barcodes. If barcodes are sent, they will overwrite existing barcodes.", Name="Barcodes", ParameterType="body")
        public ArrayList<String> Barcodes = null;

        @DataMember
        public BigDecimal NewComputerQuantity = null;
        
        public Long getSaqPk() { return SaqPk; }
        public EditInventoryRequest setSaqPk(Long value) { this.SaqPk = value; return this; }
        public Long getSasPk() { return SasPk; }
        public EditInventoryRequest setSasPk(Long value) { this.SasPk = value; return this; }
        public String getDescription() { return Description; }
        public EditInventoryRequest setDescription(String value) { this.Description = value; return this; }
        public BigDecimal getOurPrice() { return OurPrice; }
        public EditInventoryRequest setOurPrice(BigDecimal value) { this.OurPrice = value; return this; }
        public BigDecimal getRetailPrice() { return RetailPrice; }
        public EditInventoryRequest setRetailPrice(BigDecimal value) { this.RetailPrice = value; return this; }
        public BigDecimal getPriceA() { return PriceA; }
        public EditInventoryRequest setPriceA(BigDecimal value) { this.PriceA = value; return this; }
        public BigDecimal getPriceB() { return PriceB; }
        public EditInventoryRequest setPriceB(BigDecimal value) { this.PriceB = value; return this; }
        public BigDecimal getPriceC() { return PriceC; }
        public EditInventoryRequest setPriceC(BigDecimal value) { this.PriceC = value; return this; }
        public BigDecimal getMinPrice() { return MinPrice; }
        public EditInventoryRequest setMinPrice(BigDecimal value) { this.MinPrice = value; return this; }
        public BigDecimal getActiveEPrice() { return ActiveEPrice; }
        public EditInventoryRequest setActiveEPrice(BigDecimal value) { this.ActiveEPrice = value; return this; }
        public String getLocator() { return Locator; }
        public EditInventoryRequest setLocator(String value) { this.Locator = value; return this; }
        public Boolean isUpdateAllLocations() { return UpdateAllLocations; }
        public EditInventoryRequest setUpdateAllLocations(Boolean value) { this.UpdateAllLocations = value; return this; }
        public ArrayList<String> getBarcodes() { return Barcodes; }
        public EditInventoryRequest setBarcodes(ArrayList<String> value) { this.Barcodes = value; return this; }
        public BigDecimal getNewComputerQuantity() { return NewComputerQuantity; }
        public EditInventoryRequest setNewComputerQuantity(BigDecimal value) { this.NewComputerQuantity = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * This is your AIM API Key provided by Tri-Tech
        */
        @DataMember
        @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class EditInventoryResponse extends BaseResponse
    {
        
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

}

Java EditInventoryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/EditInventory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EditInventoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <ActiveEPrice>0</ActiveEPrice>
  <Barcodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Barcodes>
  <Description>String</Description>
  <Locator>String</Locator>
  <MinPrice>0</MinPrice>
  <NewComputerQuantity>0</NewComputerQuantity>
  <OurPrice>0</OurPrice>
  <PriceA>0</PriceA>
  <PriceB>0</PriceB>
  <PriceC>0</PriceC>
  <RetailPrice>0</RetailPrice>
  <SaqPk>0</SaqPk>
  <SasPk>0</SasPk>
  <UpdateAllLocations>false</UpdateAllLocations>
</EditInventoryRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EditInventoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
</EditInventoryResponse>