| POST | /api/ScheduledExchanges |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Acct | body | int | No | |
| Sub | body | int | No | |
| ExchangedItemID | body | long | No | |
| PostingDate | body | DateTime | No | |
| ScheduledDate | body | DateTime | No | |
| NewSku | body | string | No | |
| OptionId | body | long? | No | |
| ExchangeNotes | body | string | No | |
| Processed | body | bool? | No | |
| StatusId | body | long? | No | |
| FormInputList | query | array | No | Key/Value pair only. The 'Encrypted' proprety is not used for this API call. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | query | string | Yes | Field Name of the Input Field |
| Value | query | string | Yes | Value of the Input Field. |
| Encrypted | query | boolean | Yes | Whether or not the field is encryped with the C2B encryption key. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ExchangeID | form | long? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
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
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"}}