AIM Web Services

<back to all web services

ContractScheduledReturnsRequest

ContractScheduledReturns
Requires active-e Contracts Service.

The following routes are available for this service:
GET/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 ContractScheduledReturnInfo {
    /** @param {{Acct?:number,Sub?:number,Name?:string,Address?:string,Address2?:string,City?:string,Student?:string,School?:string,District?:string,Item?:string,Employee?:string,ReturnedDate?:string,ScheduledReturnDate?:string,StockNumber?:string,Serial?:string,ReturnOption?:string,ScheduledReturnedRef?:string,Status?:string,AutoPayHoldDate?:string,MobileReturnedStatus?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Acct;
    /** @type {number} */
    Sub;
    /** @type {string} */
    Name;
    /** @type {string} */
    Address;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    Student;
    /** @type {string} */
    School;
    /** @type {string} */
    District;
    /** @type {string} */
    Item;
    /** @type {string} */
    Employee;
    /** @type {?string} */
    ReturnedDate;
    /** @type {string} */
    ScheduledReturnDate;
    /** @type {string} */
    StockNumber;
    /** @type {string} */
    Serial;
    /** @type {string} */
    ReturnOption;
    /** @type {string} */
    ScheduledReturnedRef;
    /** @type {string} */
    Status;
    /** @type {?string} */
    AutoPayHoldDate;
    /** @type {boolean} */
    MobileReturnedStatus;
}
export class ContractScheduledReturnsResponse extends BaseResponse {
    /** @param {{Contracts?:ContractScheduledReturnInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ContractScheduledReturnInfo[]} */
    Contracts;
}
export class ContractScheduledReturnsRequest extends BaseSecureRequest {
    /** @param {{DateFrom?:string,DateTo?:string,DistrictId?:number,SchoolId?:number,LocationId?:number,StatusId?:number,OptionId?:number,IncludeReturned?:boolean,LanId?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?string} */
    DateFrom;
    /** @type {?string} */
    DateTo;
    /** @type {?number} */
    DistrictId;
    /** @type {?number} */
    SchoolId;
    /** @type {?number} */
    LocationId;
    /** @type {?number} */
    StatusId;
    /** @type {?number} */
    OptionId;
    /** @type {?boolean} */
    IncludeReturned;
    /** @type {string} */
    LanId;
}

JavaScript ContractScheduledReturnsRequest DTOs

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/ContractScheduledReturns HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Contracts":[{"Acct":0,"Sub":0,"Name":"String","Address":"String","Address2":"String","City":"String","Student":"String","School":"String","District":"String","Item":"String","Employee":"String","ReturnedDate":"0001-01-01T00:00:00.0000000","StockNumber":"String","Serial":"String","ReturnOption":"String","ScheduledReturnedRef":"String","Status":"String","AutoPayHoldDate":"0001-01-01T00:00:00.0000000","MobileReturnedStatus":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}