AIM Web Services

<back to all web services

OpenStoreToStoreTransfersRequest

OpenStoreToStoreTransfers
Requires active-e Inventory Service

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


/**
* OpenStoreToStoreTransfersRequires active-e Inventory Service
*/
@DataContract
open class OpenStoreToStoreTransfersRequest : BaseSecureRequest()
{
    /**
    * If sent, only transfers to the given location will be returned. Defaults to all locations.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="If sent, only transfers to the given location will be returned. Defaults to all locations.", Format="int64", Name="ToLocationId", ParameterType="query")
    var ToLocationId:Long? = null

    /**
    * If sent, only transfers from the given location will be returned. Defaults to all locations.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="If sent, only transfers from the given location will be returned. Defaults to all locations.", Format="int64", Name="FromLocationId", ParameterType="query")
    var FromLocationId:Long? = null

    /**
    * Valid values are Ready and Request. Defaults to Ready. Ready returns transfers ready to receive. Request returns transfer requests.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Valid values are Ready and Request. Defaults to Ready. Ready returns transfers ready to receive. Request returns transfer requests.", Name="Mode", ParameterType="query")
    var Mode:String? = null

    @DataMember
    var IncludeCompleted:Boolean? = null
}

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

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId: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

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class OpenStoreToStoreTransfersResponse : BaseResponse()
{
    @DataMember
    var Transfers:ArrayList<Transfer> = ArrayList<Transfer>()
}

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

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

GET /api/OpenStoreToStoreTransfers HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Transfers":[{"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}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}