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
ScheduledExchangesPostRequest Parameters:
NameParameterData TypeRequiredDescription
AcctbodyintNo
SubbodyintNo
ExchangedItemIDbodylongNo
PostingDatebodyDateTimeNo
ScheduledDatebodyDateTimeNo
NewSkubodystringNo
OptionIdbodylong?No
ExchangeNotesbodystringNo
Processedbodybool?No
StatusIdbodylong?No
FormInputListqueryarrayNoKey/Value pair only. The 'Encrypted' proprety is not used for this API call.
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
FormInput Parameters:
NameParameterData TypeRequiredDescription
KeyquerystringYesField Name of the Input Field
ValuequerystringYesValue of the Input Field.
EncryptedquerybooleanYesWhether or not the field is encryped with the C2B encryption key.
ScheduledExchangesPostResponse Parameters:
NameParameterData TypeRequiredDescription
ExchangeIDformlong?No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <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>