| POST | /api/ShortTermRentalReservation |
|---|
| 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. |
| CustomerAcct | query | int | Yes | Account of the customer making the reservation |
| Items | body | List<ShortTermRentalItem> | No | |
| Notes | body | string | No |
| 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 |
|---|---|---|---|---|
| Pk | query | long | Yes | SasPk, SaqPk, or PkhPk |
| ItemType | query | string | No | S for SerialNumber, P for Package deal. Empty for normal inventory. |
| ItemQuantity | query | decimal? | No | Quantity of item required. Does not apply to serial#s. |
| ItemRate | query | decimal? | Yes | Item rate. This is per item, so the total is this multiplied by ItemQuantity. |
| Notes | form | string | No | |
| PackageVariantItems | form | List<PackageVariantItem> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Model | form | string | No | |
| Sku | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RefNumber | form | string | 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 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
Content-Length: length
{"RefNumber":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}