AIM Web Services

<back to all web services

TransferDetailsRequest

TransferDetails
Requires active-e Inventory Service

import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * TransferDetailsRequires active-e Inventory Service
    */
    @DataContract
    public static class TransferDetailsRequest extends BaseSecureRequest
    {
        @DataMember
        public String RefNumber = 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")
        public String Mode = null;
        
        public String getRefNumber() { return RefNumber; }
        public TransferDetailsRequest setRefNumber(String value) { this.RefNumber = value; return this; }
        public String getMode() { return Mode; }
        public TransferDetailsRequest setMode(String value) { this.Mode = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static 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")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class TransferDetailsResponse extends BaseResponse
    {
        @DataMember
        public Transfer TransferInfo = null;

        @DataMember
        public ArrayList<TransferLineItem> LineItems = null;
        
        public Transfer getTransferInfo() { return TransferInfo; }
        public TransferDetailsResponse setTransferInfo(Transfer value) { this.TransferInfo = value; return this; }
        public ArrayList<TransferLineItem> getLineItems() { return LineItems; }
        public TransferDetailsResponse setLineItems(ArrayList<TransferLineItem> value) { this.LineItems = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class Transfer
    {
        @DataMember
        public String RefNumber = null;

        @DataMember
        public Date DateTime = null;

        @DataMember
        public LocationInfo From = null;

        @DataMember
        public LocationInfo To = null;

        @DataMember
        public Boolean IsRequest = null;
        
        public String getRefNumber() { return RefNumber; }
        public Transfer setRefNumber(String value) { this.RefNumber = value; return this; }
        public Date getDateTime() { return DateTime; }
        public Transfer setDateTime(Date value) { this.DateTime = value; return this; }
        public LocationInfo getFrom() { return From; }
        public Transfer setFrom(LocationInfo value) { this.From = value; return this; }
        public LocationInfo getTo() { return To; }
        public Transfer setTo(LocationInfo value) { this.To = value; return this; }
        public Boolean getIsRequest() { return IsRequest; }
        public Transfer setIsRequest(Boolean value) { this.IsRequest = value; return this; }
    }

    @DataContract
    public static class LocationInfo
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public String Desc = null;

        @DataMember
        public String ShortDesc = null;

        @DataMember
        public String Region = null;

        @DataMember
        public BigDecimal Latitude = null;

        @DataMember
        public BigDecimal Longitude = null;

        @DataMember
        public String InStorePickup = null;

        @DataMember
        public Boolean Active = null;

        @DataMember
        public Integer CashSaleAcct = null;
        
        public Long getId() { return Id; }
        public LocationInfo setId(Long value) { this.Id = value; return this; }
        public String getDesc() { return Desc; }
        public LocationInfo setDesc(String value) { this.Desc = value; return this; }
        public String getShortDesc() { return ShortDesc; }
        public LocationInfo setShortDesc(String value) { this.ShortDesc = value; return this; }
        public String getRegion() { return Region; }
        public LocationInfo setRegion(String value) { this.Region = value; return this; }
        public BigDecimal getLatitude() { return Latitude; }
        public LocationInfo setLatitude(BigDecimal value) { this.Latitude = value; return this; }
        public BigDecimal getLongitude() { return Longitude; }
        public LocationInfo setLongitude(BigDecimal value) { this.Longitude = value; return this; }
        public String getInStorePickup() { return InStorePickup; }
        public LocationInfo setInStorePickup(String value) { this.InStorePickup = value; return this; }
        public Boolean isActive() { return Active; }
        public LocationInfo setActive(Boolean value) { this.Active = value; return this; }
        public Integer getCashSaleAcct() { return CashSaleAcct; }
        public LocationInfo setCashSaleAcct(Integer value) { this.CashSaleAcct = value; return this; }
    }

    @DataContract
    public static class TransferLineItem
    {
        @DataMember
        public BigDecimal QtyIn = null;

        @DataMember
        public BigDecimal QtyOut = null;

        @DataMember
        public String Sku = null;

        @DataMember
        public String Desc = null;

        @DataMember
        public String Notes = null;

        @DataMember
        public Boolean OverShipment = null;

        @DataMember
        public Boolean IsADBook = null;

        @DataMember
        public Long SkuPk = null;

        @DataMember
        public Long SaqPk = null;

        @DataMember
        public Long SasPk = null;
        
        public BigDecimal getQtyIn() { return QtyIn; }
        public TransferLineItem setQtyIn(BigDecimal value) { this.QtyIn = value; return this; }
        public BigDecimal getQtyOut() { return QtyOut; }
        public TransferLineItem setQtyOut(BigDecimal value) { this.QtyOut = value; return this; }
        public String getSku() { return Sku; }
        public TransferLineItem setSku(String value) { this.Sku = value; return this; }
        public String getDesc() { return Desc; }
        public TransferLineItem setDesc(String value) { this.Desc = value; return this; }
        public String getNotes() { return Notes; }
        public TransferLineItem setNotes(String value) { this.Notes = value; return this; }
        public Boolean isOverShipment() { return OverShipment; }
        public TransferLineItem setOverShipment(Boolean value) { this.OverShipment = value; return this; }
        public Boolean getIsADBook() { return IsADBook; }
        public TransferLineItem setIsADBook(Boolean value) { this.IsADBook = value; return this; }
        public Long getSkuPk() { return SkuPk; }
        public TransferLineItem setSkuPk(Long value) { this.SkuPk = value; return this; }
        public Long getSaqPk() { return SaqPk; }
        public TransferLineItem setSaqPk(Long value) { this.SaqPk = value; return this; }
        public Long getSasPk() { return SasPk; }
        public TransferLineItem setSasPk(Long value) { this.SasPk = value; return this; }
    }

}

Java TransferDetailsRequest DTOs

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>