AIM Web Services

<back to all web services

ScheduledExchangesGetRequest

ScheduledExchanges
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/ScheduledExchanges
"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 ScheduledExchangesGetInfo {
    /** @param {{ExchangeID?:number,Acct?:number,Sub?:number,Name?:string,Address?:string,Address2?:string,City?:string,Student?:string,School?:string,District?:string,Item?:string,Employee?:string,ReturnedDate?:string,StockNumber?:string,Serial?:string,ReturnOption?:string,ScheduledReturnedRef?:string,Status?:string,History?:string,ExchangeRef?:number,AutoPayHoldDate?:string,ExchangedItem?:string,PostingDate?:string,ScheduledDate?:string,NewSku?:string,Notes?:string,Source?:string,Option?:string,Processed?:boolean,MobileExchangedStatus?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ExchangeID;
    /** @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} */
    StockNumber;
    /** @type {string} */
    Serial;
    /** @type {string} */
    ReturnOption;
    /** @type {string} */
    ScheduledReturnedRef;
    /** @type {string} */
    Status;
    /** @type {string} */
    History;
    /** @type {?number} */
    ExchangeRef;
    /** @type {?string} */
    AutoPayHoldDate;
    /** @type {string} */
    ExchangedItem;
    /** @type {string} */
    PostingDate;
    /** @type {string} */
    ScheduledDate;
    /** @type {string} */
    NewSku;
    /** @type {string} */
    Notes;
    /** @type {string} */
    Source;
    /** @type {string} */
    Option;
    /** @type {boolean} */
    Processed;
    /** @type {boolean} */
    MobileExchangedStatus;
}
export class ScheduledExchangesGetResponse extends BaseResponse {
    /** @param {{ScheduledExchanges?:ScheduledExchangesGetInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ScheduledExchangesGetInfo[]} */
    ScheduledExchanges;
}
export class ScheduledExchangesGetRequest extends BaseSecureRequest {
    /** @param {{ScheduledDateFrom?:string,ScheduledDateTo?:string,DistrictId?:number,SchoolId?:number,LocationId?:number,StatusId?:number,OptionId?:number,IncludeProcessed?:boolean,LanId?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?string} */
    ScheduledDateFrom;
    /** @type {?string} */
    ScheduledDateTo;
    /** @type {?number} */
    DistrictId;
    /** @type {?number} */
    SchoolId;
    /** @type {?number} */
    LocationId;
    /** @type {?number} */
    StatusId;
    /** @type {?number} */
    OptionId;
    /** @type {?boolean} */
    IncludeProcessed;
    /** @type {string} */
    LanId;
}

JavaScript ScheduledExchangesGetRequest 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/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ScheduledExchangesGetResponse 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>
  <ScheduledExchanges>
    <ScheduledExchangesGetInfo>
      <Acct>0</Acct>
      <Address>String</Address>
      <Address2>String</Address2>
      <AutoPayHoldDate>0001-01-01T00:00:00</AutoPayHoldDate>
      <City>String</City>
      <District>String</District>
      <Employee>String</Employee>
      <ExchangeID>0</ExchangeID>
      <ExchangeRef>0</ExchangeRef>
      <ExchangedItem>String</ExchangedItem>
      <History>String</History>
      <Item>String</Item>
      <MobileExchangedStatus>false</MobileExchangedStatus>
      <Name>String</Name>
      <NewSku>String</NewSku>
      <Notes>String</Notes>
      <Option>String</Option>
      <PostingDate>0001-01-01T00:00:00</PostingDate>
      <Processed>false</Processed>
      <ReturnOption>String</ReturnOption>
      <ReturnedDate>0001-01-01T00:00:00</ReturnedDate>
      <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
      <ScheduledReturnedRef>String</ScheduledReturnedRef>
      <School>String</School>
      <Serial>String</Serial>
      <Source>String</Source>
      <Status>String</Status>
      <StockNumber>String</StockNumber>
      <Student>String</Student>
      <Sub>0</Sub>
    </ScheduledExchangesGetInfo>
  </ScheduledExchanges>
</ScheduledExchangesGetResponse>