| 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 | The Login Token return by the Security API. Required for secured calls. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Key | body | string | Yes | Field name of the Input Field. If linking to an Attribute, this should match the Tag value. |
| Value | body | string | Yes | Value of the Input Field. |
| Encrypted | body | boolean | No | 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<ScheduledExchangesPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<OAuthToken>String</OAuthToken>
<Token>String</Token>
<Acct>0</Acct>
<ExchangeNotes>String</ExchangeNotes>
<ExchangedItemID>0</ExchangedItemID>
<FormInputList>
<FormInput>
<Encrypted>false</Encrypted>
<Key>String</Key>
<Value>String</Value>
</FormInput>
</FormInputList>
<NewSku>String</NewSku>
<OptionId>0</OptionId>
<PostingDate>0001-01-01T00:00:00</PostingDate>
<Processed>false</Processed>
<ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
<StatusId>0</StatusId>
<Sub>0</Sub>
</ScheduledExchangesPostRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ScheduledExchangesPostResponse 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>
<ExchangeID>0</ExchangeID>
</ScheduledExchangesPostResponse>