AIM Web Services

<back to all web services

TransferDetailsRequest

TransferDetails
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/TransferDetails
import Foundation
import ServiceStack

/**
* TransferDetailsRequires active-e Inventory Service
*/
// @DataContract
public class TransferDetailsRequest : BaseSecureRequest
{
    // @DataMember
    public var refNumber:String

    /**
    * Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Valid values are All, FullyTransferred, and NotFullyTransferred. Defaults to NotFullyTransferred.", Name="Mode", ParameterType="query")
    public var mode:String

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

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

    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)
        mode = try container.decodeIfPresent(String.self, forKey: .mode)
    }

    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 mode != nil { try container.encode(mode, forKey: .mode) }
    }
}

// @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 TransferDetailsResponse : BaseResponse
{
    // @DataMember
    public var transferInfo:Transfer

    // @DataMember
    public var lineItems:[TransferLineItem] = []

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

    private enum CodingKeys : String, CodingKey {
        case transferInfo
        case lineItems
    }

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

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

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

    // @DataMember
    public var dateTime:Date

    // @DataMember
    public var from:LocationInfo

    // @DataMember
    public var to:LocationInfo

    // @DataMember
    public var isRequest:Bool

    required public init(){}
}

// @DataContract
public class LocationInfo : Codable
{
    // @DataMember
    public var id:Int

    // @DataMember
    public var desc:String

    // @DataMember
    public var shortDesc:String

    // @DataMember
    public var region:String

    // @DataMember
    public var latitude:Double

    // @DataMember
    public var longitude:Double

    // @DataMember
    public var inStorePickup:String

    // @DataMember
    public var active:Bool

    // @DataMember
    public var cashSaleAcct:Int?

    required public init(){}
}

// @DataContract
public class TransferLineItem : Codable
{
    // @DataMember
    public var qtyIn:Double

    // @DataMember
    public var qtyOut:Double

    // @DataMember
    public var sku:String

    // @DataMember
    public var desc:String

    // @DataMember
    public var notes:String

    // @DataMember
    public var overShipment:Bool

    // @DataMember
    public var isADBook:Bool

    // @DataMember
    public var skuPk:Int?

    // @DataMember
    public var saqPk:Int?

    // @DataMember
    public var sasPk:Int?

    required public init(){}
}

Swift TransferDetailsRequest DTOs

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

HTTP + OTHER

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

GET /api/TransferDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TransferInfo":{"RefNumber":"String","From":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"To":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"IsRequest":false},"LineItems":[{"QtyIn":0,"QtyOut":0,"Sku":"String","Desc":"String","Notes":"String","OverShipment":false,"IsADBook":false,"SkuPk":0,"SaqPk":0,"SasPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}