AIM Web Services

<back to all web services

ScanForImportRequest

ScanForImport
Requires active-e Inventory Service

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

public class dtos
{

    /**
    * ScanForImportRequires active-e Inventory Service
    */
    @DataContract
    public static class ScanForImportRequest extends BaseSecureRequest
    {
        @DataMember
        public String Description = null;

        @DataMember
        public ArrayList<ScanItem> Items = null;

        @DataMember
        public Boolean ReceiveInventoryMode = null;

        @DataMember
        public Boolean AppendMode = null;
        
        public String getDescription() { return Description; }
        public ScanForImportRequest setDescription(String value) { this.Description = value; return this; }
        public ArrayList<ScanItem> getItems() { return Items; }
        public ScanForImportRequest setItems(ArrayList<ScanItem> value) { this.Items = value; return this; }
        public Boolean isReceiveInventoryMode() { return ReceiveInventoryMode; }
        public ScanForImportRequest setReceiveInventoryMode(Boolean value) { this.ReceiveInventoryMode = value; return this; }
        public Boolean isAppendMode() { return AppendMode; }
        public ScanForImportRequest setAppendMode(Boolean value) { this.AppendMode = 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 ScanItem implements IScanItem
    {
        @DataMember
        public Long SkuPk = null;

        @DataMember
        public Long SasPk = null;

        @DataMember
        public String Sku = null;

        @DataMember
        public String Serial = null;

        @DataMember
        public BigDecimal Quantity = null;

        @DataMember
        public ExceptionInfo ExceptionInfo = null;
        
        public Long getSkuPk() { return SkuPk; }
        public ScanItem setSkuPk(Long value) { this.SkuPk = value; return this; }
        public Long getSasPk() { return SasPk; }
        public ScanItem setSasPk(Long value) { this.SasPk = value; return this; }
        public String getSku() { return Sku; }
        public ScanItem setSku(String value) { this.Sku = value; return this; }
        public String getSerial() { return Serial; }
        public ScanItem setSerial(String value) { this.Serial = value; return this; }
        public BigDecimal getQuantity() { return Quantity; }
        public ScanItem setQuantity(BigDecimal value) { this.Quantity = value; return this; }
        public ExceptionInfo getExceptionInfo() { return ExceptionInfo; }
        public ScanItem setExceptionInfo(ExceptionInfo value) { this.ExceptionInfo = value; return this; }
    }

    @DataContract
    public static class ExceptionInfo
    {
        @DataMember
        public String Barcode = null;

        @DataMember
        public String Description = null;

        @DataMember
        public String Base64Image = null;

        @DataMember
        public Integer Category = null;

        @DataMember
        public Integer SubCategory = null;
        
        public String getBarcode() { return Barcode; }
        public ExceptionInfo setBarcode(String value) { this.Barcode = value; return this; }
        public String getDescription() { return Description; }
        public ExceptionInfo setDescription(String value) { this.Description = value; return this; }
        public String getBase64Image() { return Base64Image; }
        public ExceptionInfo setBase64Image(String value) { this.Base64Image = value; return this; }
        public Integer getCategory() { return Category; }
        public ExceptionInfo setCategory(Integer value) { this.Category = value; return this; }
        public Integer getSubCategory() { return SubCategory; }
        public ExceptionInfo setSubCategory(Integer value) { this.SubCategory = value; return this; }
    }

    @DataContract
    public static class ScanForImportResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<ScanErrorItem> ErrorItems = null;
        
        public ArrayList<ScanErrorItem> getErrorItems() { return ErrorItems; }
        public ScanForImportResponse setErrorItems(ArrayList<ScanErrorItem> value) { this.ErrorItems = value; return this; }
    }

    @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; }
    }

    @DataContract
    public static class ScanErrorItem implements IScanItem
    {
        @DataMember
        public Long SkuPk = null;

        @DataMember
        public Long SasPk = null;

        @DataMember
        public String Sku = null;

        @DataMember
        public String Serial = null;

        @DataMember
        public BigDecimal Quantity = null;

        @DataMember
        public ExceptionInfo ExceptionInfo = null;

        @DataMember
        public String ErrorMessage = null;
        
        public Long getSkuPk() { return SkuPk; }
        public ScanErrorItem setSkuPk(Long value) { this.SkuPk = value; return this; }
        public Long getSasPk() { return SasPk; }
        public ScanErrorItem setSasPk(Long value) { this.SasPk = value; return this; }
        public String getSku() { return Sku; }
        public ScanErrorItem setSku(String value) { this.Sku = value; return this; }
        public String getSerial() { return Serial; }
        public ScanErrorItem setSerial(String value) { this.Serial = value; return this; }
        public BigDecimal getQuantity() { return Quantity; }
        public ScanErrorItem setQuantity(BigDecimal value) { this.Quantity = value; return this; }
        public ExceptionInfo getExceptionInfo() { return ExceptionInfo; }
        public ScanErrorItem setExceptionInfo(ExceptionInfo value) { this.ExceptionInfo = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public ScanErrorItem setErrorMessage(String value) { this.ErrorMessage = value; return this; }
    }

}

Java ScanForImportRequest 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/ScanForImport HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ScanForImportRequest 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>
  <AppendMode>false</AppendMode>
  <Description>String</Description>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScanItem>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:ScanItem>
  </Items>
  <ReceiveInventoryMode>false</ReceiveInventoryMode>
</ScanForImportRequest>

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

<ScanForImportResponse 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>
  <ErrorItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScanErrorItem>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:ScanErrorItem>
  </ErrorItems>
</ScanForImportResponse>