AIM Web Services

<back to all web services

ContractScheduledReturnOptionsRequest

ContractScheduledReturnOptions
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/ContractScheduledReturnOptions
"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 ContractScheduledReturnOption {
    /** @param {{Id?:number,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Description;
}
export class ContractScheduledReturnOptionsResponse extends BaseResponse {
    /** @param {{Options?:ContractScheduledReturnOption[],Statuses?:ContractScheduledReturnOption[],AfterMobileReturnStatus?:ContractScheduledReturnOption,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ContractScheduledReturnOption[]} */
    Options;
    /** @type {ContractScheduledReturnOption[]} */
    Statuses;
    /** @type {ContractScheduledReturnOption} */
    AfterMobileReturnStatus;
}
export class ContractScheduledReturnOptionsRequest extends BaseSecureRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}

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

GET /api/ContractScheduledReturnOptions HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ContractScheduledReturnOptionsResponse 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>
  <AfterMobileReturnStatus>
    <Description>String</Description>
    <Id>0</Id>
  </AfterMobileReturnStatus>
  <Options>
    <ContractScheduledReturnOption>
      <Description>String</Description>
      <Id>0</Id>
    </ContractScheduledReturnOption>
  </Options>
  <Statuses>
    <ContractScheduledReturnOption>
      <Description>String</Description>
      <Id>0</Id>
    </ContractScheduledReturnOption>
  </Statuses>
</ContractScheduledReturnOptionsResponse>