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
ShortTermRentalAvailabilityRequest Parameters:
NameParameterData TypeRequiredDescription
PickupDatequeryDateTimeYesDate/Time the item is to be picked up.
ReturnDatequeryDateTimeYesDate/Time the item is to be returned.
SaqPkquerylong?NoPK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
SasPkquerylong?NoPK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
PkhPkquerylong?NoPK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
Categoryqueryint?NoPass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
SubCategoryqueryint?NoPass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory
ItemQuantityquerydecimal?YesQuantity of item required. Does not apply to serial#s.
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
ShortTermRentalAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
IsAvailableformboolNo
AvailableSkusformList<AvailableSku>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
AvailableSku Parameters:
NameParameterData TypeRequiredDescription
SaqPkformlongNo
SkuformstringNo
DescriptionformstringNo

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"}}