| GET | /api/OpenStoreToStoreTransfers |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* OpenStoreToStoreTransfersRequires active-e Inventory Service
*/
@DataContract
public static class OpenStoreToStoreTransfersRequest extends 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")
public Long ToLocationId = 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")
public Long FromLocationId = 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")
public String Mode = null;
@DataMember
public Boolean IncludeCompleted = null;
public Long getToLocationId() { return ToLocationId; }
public OpenStoreToStoreTransfersRequest setToLocationId(Long value) { this.ToLocationId = value; return this; }
public Long getFromLocationId() { return FromLocationId; }
public OpenStoreToStoreTransfersRequest setFromLocationId(Long value) { this.FromLocationId = value; return this; }
public String getMode() { return Mode; }
public OpenStoreToStoreTransfersRequest setMode(String value) { this.Mode = value; return this; }
public Boolean isIncludeCompleted() { return IncludeCompleted; }
public OpenStoreToStoreTransfersRequest setIncludeCompleted(Boolean value) { this.IncludeCompleted = 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 OpenStoreToStoreTransfersResponse extends BaseResponse
{
@DataMember
public ArrayList<Transfer> Transfers = null;
public ArrayList<Transfer> getTransfers() { return Transfers; }
public OpenStoreToStoreTransfersResponse setTransfers(ArrayList<Transfer> value) { this.Transfers = 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; }
}
}
Java OpenStoreToStoreTransfersRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}