AIM Web Services

<back to all web services

ShortTermRentalInventoryRequest

ShortTermRentalInventory
Requires active-e Short Term Rental Service

The following routes are available for this service:
GET/api/ShortTermRentalInventory
"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 ShortTermRentalInventoryRate {
    /** @param {{HeaderDesc?:string,HeaderNotes?:string,Desc?:string,IntervalType?:string,Group?:string,Notes?:string,Amt?:number,TimeInterval?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    HeaderDesc;
    /** @type {string} */
    HeaderNotes;
    /** @type {string} */
    Desc;
    /** @type {string} */
    IntervalType;
    /** @type {string} */
    Group;
    /** @type {string} */
    Notes;
    /** @type {number} */
    Amt;
    /** @type {number} */
    TimeInterval;
}
export class ShortTermRentalInventoryObj {
    /** @param {{Rates?:ShortTermRentalInventoryRate[],AvailableSerialPks?:number[],SaqPk?:number,SkuPk?:number,PkhPk?:number,Sku?:string,Package?:string,InvType?:string,AvailableQty?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ShortTermRentalInventoryRate[]} */
    Rates;
    /** @type {number[]} */
    AvailableSerialPks;
    /** @type {?number} */
    SaqPk;
    /** @type {?number} */
    SkuPk;
    /** @type {?number} */
    PkhPk;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Package;
    /** @type {string} */
    InvType;
    /** @type {number} */
    AvailableQty;
}
export class ShortTermRentalInventoryResponse extends BaseResponse {
    /** @param {{Results?:ShortTermRentalInventoryObj[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {ShortTermRentalInventoryObj[]} */
    Results;
}
export class ShortTermRentalInventoryRequest extends BaseSecureRequest {
    /** @param {{Item?:string,LocationCode?:string,ItemPk?:number,PkType?:string,Category?:number,SubCategory?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory */
    Item;
    /** @type {string} */
    LocationCode;
    /**
     * @type {?number}
     * @description Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory */
    ItemPk;
    /**
     * @type {string}
     * @description Type of the key passed in. S for SasPk, Q for SaqPk, P for PkhPk. Pass in either this plus ItemPk *OR* Item *OR* Category + SubCategory */
    PkType;
    /**
     * @type {?number}
     * @description Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType */
    Category;
    /**
     * @type {?number}
     * @description Pass in either Category + this *OR* Item *OR* ItemPk + PkType */
    SubCategory;
}

JavaScript ShortTermRentalInventoryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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

GET /api/ShortTermRentalInventory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Results":[{"Rates":[{"HeaderDesc":"String","HeaderNotes":"String","Desc":"String","IntervalType":"String","Group":"String","Notes":"String","Amt":0,"TimeInterval":0}],"AvailableSerialPks":[0],"SaqPk":0,"SkuPk":0,"PkhPk":0,"Sku":"String","Package":"String","InvType":"String","AvailableQty":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}