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 java.math.*
import java.util.*
import net.servicestack.client.*


/**
* TransferDetailsRequires active-e Inventory Service
*/
@DataContract
open class TransferDetailsRequest : BaseSecureRequest()
{
    @DataMember
    var RefNumber:String? = null

    /**
    * 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")
    var Mode:String? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    var Token:String? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class TransferDetailsResponse : BaseResponse()
{
    @DataMember
    var TransferInfo:Transfer? = null

    @DataMember
    var LineItems:ArrayList<TransferLineItem> = ArrayList<TransferLineItem>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

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

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

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

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

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

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class Transfer
{
    @DataMember
    var RefNumber:String? = null

    @DataMember
    var DateTime:Date? = null

    @DataMember
    var From:LocationInfo? = null

    @DataMember
    var To:LocationInfo? = null

    @DataMember
    var IsRequest:Boolean? = null
}

@DataContract
open class LocationInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null

    @DataMember
    var Region:String? = null

    @DataMember
    var Latitude:BigDecimal? = null

    @DataMember
    var Longitude:BigDecimal? = null

    @DataMember
    var InStorePickup:String? = null

    @DataMember
    var Active:Boolean? = null

    @DataMember
    var CashSaleAcct:Int? = null
}

@DataContract
open class TransferLineItem
{
    @DataMember
    var QtyIn:BigDecimal? = null

    @DataMember
    var QtyOut:BigDecimal? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var OverShipment:Boolean? = null

    @DataMember
    var IsADBook:Boolean? = null

    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var SaqPk:Long? = null

    @DataMember
    var SasPk:Long? = null
}

Kotlin TransferDetailsRequest 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.

GET /api/TransferDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<TransferDetailsResponse 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>
  <LineItems>
    <TransferLineItem>
      <Desc>String</Desc>
      <IsADBook>false</IsADBook>
      <Notes>String</Notes>
      <OverShipment>false</OverShipment>
      <QtyIn>0</QtyIn>
      <QtyOut>0</QtyOut>
      <SaqPk>0</SaqPk>
      <SasPk>0</SasPk>
      <Sku>String</Sku>
      <SkuPk>0</SkuPk>
    </TransferLineItem>
  </LineItems>
  <TransferInfo>
    <DateTime>0001-01-01T00:00:00</DateTime>
    <From xmlns:d3p1="http://schemas.datacontract.org/2004/07/AIM">
      <d3p1:Active>false</d3p1:Active>
      <d3p1:CashSaleAcct>0</d3p1:CashSaleAcct>
      <d3p1:Desc>String</d3p1:Desc>
      <d3p1:Id>0</d3p1:Id>
      <d3p1:InStorePickup>String</d3p1:InStorePickup>
      <d3p1:Latitude>0</d3p1:Latitude>
      <d3p1:Longitude>0</d3p1:Longitude>
      <d3p1:Region>String</d3p1:Region>
      <d3p1:ShortDesc>String</d3p1:ShortDesc>
    </From>
    <IsRequest>false</IsRequest>
    <RefNumber>String</RefNumber>
    <To xmlns:d3p1="http://schemas.datacontract.org/2004/07/AIM">
      <d3p1:Active>false</d3p1:Active>
      <d3p1:CashSaleAcct>0</d3p1:CashSaleAcct>
      <d3p1:Desc>String</d3p1:Desc>
      <d3p1:Id>0</d3p1:Id>
      <d3p1:InStorePickup>String</d3p1:InStorePickup>
      <d3p1:Latitude>0</d3p1:Latitude>
      <d3p1:Longitude>0</d3p1:Longitude>
      <d3p1:Region>String</d3p1:Region>
      <d3p1:ShortDesc>String</d3p1:ShortDesc>
    </To>
  </TransferInfo>
</TransferDetailsResponse>