AIM Web Services

<back to all web services

ShortTermRentalAvailabilityRequest

ShortTermRentalAvailability
Requires active-e Short Term Rental Service

The following routes are available for this service:
GET/api/ShortTermRentalAvailability
"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 AvailableSku {
    /** @param {{SaqPk?:number,Sku?:string,Description?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    SaqPk;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Description;
}
export class ShortTermRentalAvailabilityResponse extends BaseResponse {
    /** @param {{IsAvailable?:boolean,AvailableSkus?:AvailableSku[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    IsAvailable;
    /** @type {AvailableSku[]} */
    AvailableSkus;
}
export class ShortTermRentalAvailabilityRequest extends BaseSecureRequest {
    /** @param {{PickupDate?:string,ReturnDate?:string,SaqPk?:number,SasPk?:number,PkhPk?:number,Category?:number,SubCategory?:number,ItemQuantity?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {string}
     * @description Date/Time the item is to be picked up. */
    PickupDate;
    /**
     * @type {string}
     * @description Date/Time the item is to be returned. */
    ReturnDate;
    /**
     * @type {?number}
     * @description PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
    SaqPk;
    /**
     * @type {?number}
     * @description PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
    SasPk;
    /**
     * @type {?number}
     * @description PK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
    PkhPk;
    /**
     * @type {?number}
     * @description Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
    Category;
    /**
     * @type {?number}
     * @description Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory */
    SubCategory;
    /**
     * @type {number}
     * @description Quantity of item required. Does not apply to serial#s. */
    ItemQuantity;
}

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

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

{"IsAvailable":false,"AvailableSkus":[{"SaqPk":0,"Sku":"String","Description":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}