| 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 | The Login Token return by the Security API. Required for secured calls. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
| DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
| AppId | Header | string | Yes | An identifier for your integration |
| 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<ShortTermRentalReservationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<OAuthToken>String</OAuthToken>
<Token>String</Token>
<CustomerAcct>0</CustomerAcct>
<Items>
<ShortTermRentalItem>
<ItemQuantity>0</ItemQuantity>
<ItemRate>0</ItemRate>
<ItemType>String</ItemType>
<Notes>String</Notes>
<PackageVariantItems>
<PackageVariantItem>
<Model>String</Model>
<Sku>String</Sku>
</PackageVariantItem>
</PackageVariantItems>
<Pk>0</Pk>
</ShortTermRentalItem>
</Items>
<Notes>String</Notes>
<PickupDate>0001-01-01T00:00:00</PickupDate>
<ReturnDate>0001-01-01T00:00:00</ReturnDate>
</ShortTermRentalReservationRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ShortTermRentalReservationResponse 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>
<RefNumber>String</RefNumber>
</ShortTermRentalReservationResponse>