AIM Web Services

<back to all web services

ScheduledExchangesPostRequest

ScheduledExchanges
Requires active-e Contracts Service.

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

public class dtos
{

    /**
    * ScheduledExchangesRequires active-e Contracts Service.
    */
    @DataContract
    public static class ScheduledExchangesPostRequest extends BaseSecureRequest
    {
        @DataMember
        public Integer Acct = null;

        @DataMember
        public Integer Sub = null;

        @DataMember
        public Long ExchangedItemID = null;

        @DataMember
        public Date PostingDate = null;

        @DataMember
        public Date ScheduledDate = null;

        @DataMember
        public String NewSku = null;

        @DataMember
        public Long OptionId = null;

        @DataMember
        public String ExchangeNotes = null;

        @DataMember
        public Boolean Processed = null;

        @DataMember
        public Long StatusId = null;

        /**
        * Key/Value pair only. The 'Encrypted' proprety is not used for this API call.
        */
        @DataMember
        @ApiMember(DataType="array", Description="Key/Value pair only. The 'Encrypted' proprety is not used for this API call.", Name="FormInputList", ParameterType="query")
        public ArrayList<FormInput> FormInputList = null;
        
        public Integer getAcct() { return Acct; }
        public ScheduledExchangesPostRequest setAcct(Integer value) { this.Acct = value; return this; }
        public Integer getSub() { return Sub; }
        public ScheduledExchangesPostRequest setSub(Integer value) { this.Sub = value; return this; }
        public Long getExchangedItemID() { return ExchangedItemID; }
        public ScheduledExchangesPostRequest setExchangedItemID(Long value) { this.ExchangedItemID = value; return this; }
        public Date getPostingDate() { return PostingDate; }
        public ScheduledExchangesPostRequest setPostingDate(Date value) { this.PostingDate = value; return this; }
        public Date getScheduledDate() { return ScheduledDate; }
        public ScheduledExchangesPostRequest setScheduledDate(Date value) { this.ScheduledDate = value; return this; }
        public String getNewSku() { return NewSku; }
        public ScheduledExchangesPostRequest setNewSku(String value) { this.NewSku = value; return this; }
        public Long getOptionId() { return OptionId; }
        public ScheduledExchangesPostRequest setOptionId(Long value) { this.OptionId = value; return this; }
        public String getExchangeNotes() { return ExchangeNotes; }
        public ScheduledExchangesPostRequest setExchangeNotes(String value) { this.ExchangeNotes = value; return this; }
        public Boolean isProcessed() { return Processed; }
        public ScheduledExchangesPostRequest setProcessed(Boolean value) { this.Processed = value; return this; }
        public Long getStatusId() { return StatusId; }
        public ScheduledExchangesPostRequest setStatusId(Long value) { this.StatusId = value; return this; }
        public ArrayList<FormInput> getFormInputList() { return FormInputList; }
        public ScheduledExchangesPostRequest setFormInputList(ArrayList<FormInput> value) { this.FormInputList = 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(Name="FormInput")
    public static class FormInput
    {
        /**
        * Field Name of the Input Field
        */
        @DataMember
        @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
        public String Key = null;

        /**
        * Value of the Input Field.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
        public String Value = null;

        /**
        * Whether or not the field is encryped with the C2B encryption key.
        */
        @DataMember
        @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
        public Boolean Encrypted = null;
        
        public String getKey() { return Key; }
        public FormInput setKey(String value) { this.Key = value; return this; }
        public String getValue() { return Value; }
        public FormInput setValue(String value) { this.Value = value; return this; }
        public Boolean isEncrypted() { return Encrypted; }
        public FormInput setEncrypted(Boolean value) { this.Encrypted = value; return this; }
    }

    @DataContract
    public static class ScheduledExchangesPostResponse extends BaseResponse
    {
        @DataMember
        public Long ExchangeID = null;
        
        public Long getExchangeID() { return ExchangeID; }
        public ScheduledExchangesPostResponse setExchangeID(Long value) { this.ExchangeID = 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; }
    }

}

Java ScheduledExchangesPostRequest DTOs

POST /api/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Acct":0,"Sub":0,"ExchangedItemID":0,"NewSku":"String","OptionId":0,"ExchangeNotes":"String","Processed":false,"StatusId":0,"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"ExchangeID":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}