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 Foundation
import ServiceStack

/**
* ScanForImportRequires active-e Inventory Service
*/
// @DataContract
public class ScanForImportRequest : BaseSecureRequest
{
    // @DataMember
    public var Description:String

    // @DataMember
    public var items:[ScanItem] = []

    // @DataMember
    public var receiveInventoryMode:Bool?

    // @DataMember
    public var appendMode:Bool?

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case Description
        case items
        case receiveInventoryMode
        case appendMode
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        Description = try container.decodeIfPresent(String.self, forKey: .Description)
        items = try container.decodeIfPresent([ScanItem].self, forKey: .items) ?? []
        receiveInventoryMode = try container.decodeIfPresent(Bool.self, forKey: .receiveInventoryMode)
        appendMode = try container.decodeIfPresent(Bool.self, forKey: .appendMode)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if Description != nil { try container.encode(Description, forKey: .Description) }
        if items.count > 0 { try container.encode(items, forKey: .items) }
        if receiveInventoryMode != nil { try container.encode(receiveInventoryMode, forKey: .receiveInventoryMode) }
        if appendMode != nil { try container.encode(appendMode, forKey: .appendMode) }
    }
}

// @DataContract
public class BaseSecureRequest : BaseRequest
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public var token:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public var deviceId:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public var appId:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case token
        case deviceId
        case appId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        token = try container.decodeIfPresent(String.self, forKey: .token)
        deviceId = try container.decodeIfPresent(String.self, forKey: .deviceId)
        appId = try container.decodeIfPresent(String.self, forKey: .appId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if token != nil { try container.encode(token, forKey: .token) }
        if deviceId != nil { try container.encode(deviceId, forKey: .deviceId) }
        if appId != nil { try container.encode(appId, forKey: .appId) }
    }
}

// @DataContract
public class BaseRequest : Codable
{
    /**
    * 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 var apiKey:String

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public var oAuthToken:String

    required public init(){}
}

// @DataContract
public class ScanItem : IScanItem, Codable
{
    // @DataMember
    public var skuPk:Int?

    // @DataMember
    public var sasPk:Int?

    // @DataMember
    public var sku:String

    // @DataMember
    public var serial:String

    // @DataMember
    public var quantity:Double

    // @DataMember
    public var exceptionInfo:ExceptionInfo

    required public init(){}
}

// @DataContract
public class ExceptionInfo : Codable
{
    // @DataMember
    public var barcode:String

    // @DataMember
    public var Description:String

    // @DataMember
    public var base64Image:String

    // @DataMember
    public var category:Int

    // @DataMember
    public var subCategory:Int?

    required public init(){}
}

// @DataContract
public class ScanForImportResponse : BaseResponse
{
    // @DataMember
    public var errorItems:[ScanErrorItem] = []

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case errorItems
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        errorItems = try container.decodeIfPresent([ScanErrorItem].self, forKey: .errorItems) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if errorItems.count > 0 { try container.encode(errorItems, forKey: .errorItems) }
    }
}

// @DataContract
public class BaseResponse : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public var status:BaseResponseResult

    required public init(){}
}

// @DataContract
public class BaseResponseResult : Codable
{
    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public var statusCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public var login:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public var errorCode:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public var errorDisplayText:String

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public var errorMessage:String

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

    /**
    * 
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public var ipAddress:String

    required public init(){}
}

// @DataContract
public class ScanErrorItem : IScanItem, Codable
{
    // @DataMember
    public var skuPk:Int?

    // @DataMember
    public var sasPk:Int?

    // @DataMember
    public var sku:String

    // @DataMember
    public var serial:String

    // @DataMember
    public var quantity:Double

    // @DataMember
    public var exceptionInfo:ExceptionInfo

    // @DataMember
    public var errorMessage:String

    required public init(){}
}

Swift 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>