AIM Web Services

<back to all web services

ShortTermRentalReservationRequest

ShortTermRentalReservation
Requires active-e Short Term Rental Service

The following routes are available for this service:
POST/api/ShortTermRentalReservation
"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 ShortTermRentalReservationResponse extends BaseResponse {
    /** @param {{RefNumber?:string,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    RefNumber;
}
export class PackageVariantItem {
    /** @param {{Model?:string,Sku?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Model;
    /** @type {string} */
    Sku;
}
export class ShortTermRentalItem {
    /** @param {{Pk?:number,ItemType?:string,ItemQuantity?:number,ItemRate?:number,Notes?:string,PackageVariantItems?:PackageVariantItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description SasPk, SaqPk, or PkhPk */
    Pk;
    /**
     * @type {string}
     * @description S for SerialNumber, P for Package deal. Empty for normal inventory. */
    ItemType;
    /**
     * @type {?number}
     * @description Quantity of item required. Does not apply to serial#s. */
    ItemQuantity;
    /**
     * @type {number}
     * @description Item rate. This is per item, so the total is this multiplied by ItemQuantity. */
    ItemRate;
    /** @type {string} */
    Notes;
    /** @type {PackageVariantItem[]} */
    PackageVariantItems;
}
export class ShortTermRentalReservationRequest extends BaseSecureRequest {
    /** @param {{PickupDate?:string,ReturnDate?:string,CustomerAcct?:number,Items?:ShortTermRentalItem[],Notes?:string,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 Account of the customer making the reservation */
    CustomerAcct;
    /** @type {ShortTermRentalItem[]} */
    Items;
    /** @type {string} */
    Notes;
}

JavaScript ShortTermRentalReservationRequest 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.

POST /api/ShortTermRentalReservation HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CustomerAcct":0,"Items":[{"Pk":0,"ItemType":"String","ItemQuantity":0,"ItemRate":0,"Notes":"String","PackageVariantItems":[{"Model":"String","Sku":"String"}]}],"Notes":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"RefNumber":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}