AIM Web Services

<back to all web services

ContractScheduledReturnsPostRequest

ContractScheduledReturns
Requires active-e Contracts Service.

The following routes are available for this service:
POST/api/ContractScheduledReturns
"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 ContractScheduledReturnsPostResponse extends BaseResponse {
    /** @param {{RefNumber?:string,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    RefNumber;
}
export class ContractScheduledReturnsPostRequest extends BaseSecureRequest {
    /** @param {{Acct?:number,Sub?:number,OptionId?:number,ReturnDate?:string,ReturnNotes?:string,AutoPayHoldDate?:string,StatusId?:number,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} */
    OptionId;
    /** @type {string} */
    ReturnDate;
    /** @type {string} */
    ReturnNotes;
    /** @type {?string} */
    AutoPayHoldDate;
    /** @type {?number} */
    StatusId;
}

JavaScript ContractScheduledReturnsPostRequest DTOs

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/ContractScheduledReturns HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContractScheduledReturnsPostRequest 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>
  <AutoPayHoldDate>0001-01-01T00:00:00</AutoPayHoldDate>
  <OptionId>0</OptionId>
  <ReturnDate>0001-01-01T00:00:00</ReturnDate>
  <ReturnNotes>String</ReturnNotes>
  <StatusId>0</StatusId>
  <Sub>0</Sub>
</ContractScheduledReturnsPostRequest>

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

<ContractScheduledReturnsPostResponse 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>
  <RefNumber>String</RefNumber>
</ContractScheduledReturnsPostResponse>