AIM Web Services

<back to all web services

TransferInventoryOutRequest

TransferInventoryOut
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/TransferInventoryOut
import Foundation
import ServiceStack

/**
* TransferInventoryOutRequires active-e Inventory Service
*/
// @DataContract
public class TransferInventoryOutRequest : BaseSecureRequest
{
    // @DataMember
    public var locationPk:Int?

    // @DataMember
    public var reasonCategory:Int

    // @DataMember
    public var vendorNumber:Int?

    // @DataMember
    public var customerAcct:Int?

    // @DataMember
    public var rma:String

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

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

    private enum CodingKeys : String, CodingKey {
        case locationPk
        case reasonCategory
        case vendorNumber
        case customerAcct
        case rma
        case items
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        locationPk = try container.decodeIfPresent(Int.self, forKey: .locationPk)
        reasonCategory = try container.decodeIfPresent(Int.self, forKey: .reasonCategory)
        vendorNumber = try container.decodeIfPresent(Int.self, forKey: .vendorNumber)
        customerAcct = try container.decodeIfPresent(Int.self, forKey: .customerAcct)
        rma = try container.decodeIfPresent(String.self, forKey: .rma)
        items = try container.decodeIfPresent([ScanTransferOutItem].self, forKey: .items) ?? []
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if locationPk != nil { try container.encode(locationPk, forKey: .locationPk) }
        if reasonCategory != nil { try container.encode(reasonCategory, forKey: .reasonCategory) }
        if vendorNumber != nil { try container.encode(vendorNumber, forKey: .vendorNumber) }
        if customerAcct != nil { try container.encode(customerAcct, forKey: .customerAcct) }
        if rma != nil { try container.encode(rma, forKey: .rma) }
        if items.count > 0 { try container.encode(items, forKey: .items) }
    }
}

// @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 ScanTransferOutItem : 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 pending:Bool

    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 TransferInventoryOutResponse : BaseResponse
{
    // @DataMember
    public var refNumber:String

    // @DataMember
    public var errorItems:[ScanErrorItem] = []

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

    private enum CodingKeys : String, CodingKey {
        case refNumber
        case errorItems
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        refNumber = try container.decodeIfPresent(String.self, forKey: .refNumber)
        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 refNumber != nil { try container.encode(refNumber, forKey: .refNumber) }
        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 TransferInventoryOutRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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

{"LocationPk":0,"ReasonCategory":0,"VendorNumber":0,"CustomerAcct":0,"RMA":"String","Items":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"Pending":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"RefNumber":"String","ErrorItems":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"ErrorMessage":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}