AIM Web Services

<back to all web services

ScheduledExchangesPostRequest

ScheduledExchanges
Requires active-e Contracts Service.

The following routes are available for this service:
POST/api/ScheduledExchanges
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class ScheduledExchangesPostResponse extends BaseResponse {
    /** @param {{ExchangeID?:number,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    ExchangeID;
}
export class FormInput {
    /** @param {{Key?:string,Value?:string,Encrypted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Field Name of the Input Field */
    Key;
    /**
     * @type {string}
     * @description Value of the Input Field. */
    Value;
    /**
     * @type {boolean}
     * @description Whether or not the field is encryped with the C2B encryption key. */
    Encrypted;
}
export class ScheduledExchangesPostRequest extends BaseSecureRequest {
    /** @param {{Acct?:number,Sub?:number,ExchangedItemID?:number,PostingDate?:string,ScheduledDate?:string,NewSku?:string,OptionId?:number,ExchangeNotes?:string,Processed?:boolean,StatusId?:number,FormInputList?:FormInput[],Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    Acct;
    /** @type {number} */
    Sub;
    /** @type {number} */
    ExchangedItemID;
    /** @type {string} */
    PostingDate;
    /** @type {string} */
    ScheduledDate;
    /** @type {string} */
    NewSku;
    /** @type {?number} */
    OptionId;
    /** @type {string} */
    ExchangeNotes;
    /** @type {?boolean} */
    Processed;
    /** @type {?number} */
    StatusId;
    /**
     * @type {FormInput[]}
     * @description Key/Value pair only. The 'Encrypted' proprety is not used for this API call. */
    FormInputList;
}

JavaScript ScheduledExchangesPostRequest 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.

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