| GET | /api/ShortTermRentalAvailability |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PickupDate | query | DateTime | Yes | Date/Time the item is to be picked up. |
| ReturnDate | query | DateTime | Yes | Date/Time the item is to be returned. |
| SaqPk | query | long? | No | PK of the Scsaqty to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory |
| SasPk | query | long? | No | PK of the Serial# to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory |
| PkhPk | query | long? | No | PK of the Package Deal to lookup. Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory |
| Category | query | int? | No | Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory |
| SubCategory | query | int? | No | Pass in SkuPk *OR* SasPK *OR* PkhPk *OR* Category and SubCategory |
| ItemQuantity | query | decimal? | Yes | Quantity of item required. Does not apply to serial#s. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| IsAvailable | form | bool | No | |
| AvailableSkus | form | List<AvailableSku> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StatusCode | body | string | No | |
| Login | body | string | No | |
| ErrorCode | body | string | No | |
| ErrorDisplayText | body | string | No | |
| ErrorMessage | body | string | No | |
| DomainName | body | string | No | |
| IpAddress | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SaqPk | form | long | No | |
| Sku | form | string | No | |
| Description | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ShortTermRentalAvailabilityResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<Status>
<DomainName>String</DomainName>
<ErrorCode>String</ErrorCode>
<ErrorDisplayText>String</ErrorDisplayText>
<ErrorMessage>String</ErrorMessage>
<IpAddress>String</IpAddress>
<Login>String</Login>
<StatusCode>String</StatusCode>
</Status>
<AvailableSkus>
<AvailableSku>
<Description>String</Description>
<SaqPk>0</SaqPk>
<Sku>String</Sku>
</AvailableSku>
</AvailableSkus>
<IsAvailable>false</IsAvailable>
</ShortTermRentalAvailabilityResponse>