AIM Web Services

<back to all web services

GetStationsRequest

GetStations
Requires active-e Station Reservations Service

"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /**
     * @type {string}
     * @description The OAuthToken token return by AeServices30 */
    OAuthToken;
    /**
     * @type {string}
     * @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    DeviceId;
    /**
     * @type {string}
     * @description An identifier for your integration */
    AppId;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description The Login Token return by the Security API. Required for secured calls. */
    Token;
}
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 LocationInfo {
    /** @param {{Id?:number,Desc?:string,ShortDesc?:string,Region?:string,Latitude?:number,Longitude?:number,InStorePickup?:string,Active?:boolean,CashSaleAcct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Desc;
    /** @type {string} */
    ShortDesc;
    /** @type {string} */
    Region;
    /** @type {number} */
    Latitude;
    /** @type {number} */
    Longitude;
    /** @type {string} */
    InStorePickup;
    /** @type {boolean} */
    Active;
    /** @type {?number} */
    CashSaleAcct;
}
export class ReservationInfo {
    /** @param {{Start?:string,End?:string,CustomerAcct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Start;
    /** @type {string} */
    End;
    /** @type {?number} */
    CustomerAcct;
}
export class StationInfo {
    /** @param {{Id?:number,Name?:string,WebDescription?:string,MaxUsers?:number,Location?:LocationInfo,CurrentStatus?:string,Reservations?:ReservationInfo[],AvailabilityCalendar?:string[],Topic?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    WebDescription;
    /** @type {number} */
    MaxUsers;
    /** @type {LocationInfo} */
    Location;
    /** @type {string} */
    CurrentStatus;
    /** @type {ReservationInfo[]} */
    Reservations;
    /** @type {string[]} */
    AvailabilityCalendar;
    /** @type {string} */
    Topic;
}
export class GetStationsResponse extends BaseResponse {
    /** @param {{Stations?:StationInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {StationInfo[]} */
    Stations;
}
export class GetStationsRequest extends BaseSecureRequest {
    /** @param {{LocationId?:number,GroupId?:number,Acct?:number,GenerateAvailabilityCalendar?:boolean,AvailabilityCalendarDays?:number,AvailabilityCalendarDate?:string,AvailabilityCalendarReservationLength?:number,Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description If sent, only stations at the passed location will be returned. */
    LocationId;
    /**
     * @type {?number}
     * @description If sent, only stations in the passed Station group will be returned */
    GroupId;
    /** @type {?number} */
    Acct;
    /** @type {boolean} */
    GenerateAvailabilityCalendar;
    /**
     * @type {?number}
     * @description If sent, the availability calendar will be for the next X days */
    AvailabilityCalendarDays;
    /**
     * @type {?string}
     * @description If sent, the availability calendar will be for the sent date only */
    AvailabilityCalendarDate;
    /**
     * @type {?number}
     * @description If sent, the availability calendar will look for available slots of length X minutes. Uses the interval of the station group if not sent. */
    AvailabilityCalendarReservationLength;
}

JavaScript GetStationsRequest DTOs

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

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

<GetStationsResponse 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>
  <Stations>
    <GetStationsResponse.StationInfo>
      <AvailabilityCalendar xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:dateTime>0001-01-01T00:00:00</d4p1:dateTime>
      </AvailabilityCalendar>
      <CurrentStatus>String</CurrentStatus>
      <Id>0</Id>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Active>false</d4p1:Active>
        <d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
        <d4p1:Desc>String</d4p1:Desc>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:InStorePickup>String</d4p1:InStorePickup>
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:ShortDesc>String</d4p1:ShortDesc>
      </Location>
      <MaxUsers>0</MaxUsers>
      <Name>String</Name>
      <Reservations>
        <GetStationsResponse.StationInfo.ReservationInfo>
          <CustomerAcct>0</CustomerAcct>
          <End>0001-01-01T00:00:00</End>
          <Start>0001-01-01T00:00:00</Start>
        </GetStationsResponse.StationInfo.ReservationInfo>
      </Reservations>
      <Topic>String</Topic>
      <WebDescription>String</WebDescription>
    </GetStationsResponse.StationInfo>
  </Stations>
</GetStationsResponse>