AIM Web Services

<back to all web services

LocatorListingRequest

LocatorListing
Requires active-e Inventory Service.

The following routes are available for this service:
GET/api/LocatorListing
"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 LocatorInfo {
    /** @param {{Locator?:string,StLoc?:string,Type?:string,Notes?:string,SingleItem?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Locator;
    /** @type {string} */
    StLoc;
    /** @type {string} */
    Type;
    /** @type {string} */
    Notes;
    /** @type {boolean} */
    SingleItem;
}
export class LocatorListingResponse extends BaseResponse {
    /** @param {{LocatorListing?:LocatorInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {LocatorInfo[]} */
    LocatorListing;
}
export class LocatorListingRequest extends BaseSecureRequest {
    /** @param {{LocationId?:number,Type?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description If sent, only Locators for the given location will be returned */
    LocationId;
    /**
     * @type {string}
     * @description Can be INV (Inventory) or TIC (Ticket). Defaults to INV. */
    Type;
}

JavaScript LocatorListingRequest 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/LocatorListing HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"LocatorListing":[{"Locator":"String","StLoc":"String","Type":"String","Notes":"String","SingleItem":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}