| GET | /api/ShortTermRentalInventory |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Item | query | string | No | Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory |
| LocationCode | query | string | No | |
| ItemPk | query | long? | No | Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory |
| PkType | query | string | No | Type of the key passed in. S for SasPk, Q for SaqPk, P for PkhPk. Pass in either this plus ItemPk *OR* Item *OR* Category + SubCategory |
| Category | query | int? | No | Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType |
| SubCategory | query | int? | No | Pass in either Category + this *OR* Item *OR* ItemPk + PkType |
| 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 |
|---|---|---|---|---|
| Results | form | List<ShortTermRentalInventoryObj> | 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 |
|---|---|---|---|---|
| Rates | form | List<ShortTermRentalInventoryRate> | No | |
| AvailableSerialPks | form | List<long> | No | |
| SaqPk | form | long? | No | |
| SkuPk | form | long? | No | |
| PkhPk | form | long? | No | |
| Sku | form | string | No | |
| Package | form | string | No | |
| InvType | form | string | No | |
| AvailableQty | form | decimal | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| HeaderDesc | form | string | No | |
| HeaderNotes | form | string | No | |
| Desc | form | string | No | |
| IntervalType | form | string | No | |
| Group | form | string | No | |
| Notes | form | string | No | |
| Amt | form | decimal | No | |
| TimeInterval | form | int | 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/ShortTermRentalInventory HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ShortTermRentalInventoryResponse 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>
<Results>
<ShortTermRentalInventoryObj>
<AvailableQty>0</AvailableQty>
<AvailableSerialPks xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:long>0</d4p1:long>
</AvailableSerialPks>
<InvType>String</InvType>
<Package>String</Package>
<PkhPk>0</PkhPk>
<Rates>
<ShortTermRentalInventoryRate>
<Amt>0</Amt>
<Desc>String</Desc>
<Group>String</Group>
<HeaderDesc>String</HeaderDesc>
<HeaderNotes>String</HeaderNotes>
<IntervalType>String</IntervalType>
<Notes>String</Notes>
<TimeInterval>0</TimeInterval>
</ShortTermRentalInventoryRate>
</Rates>
<SaqPk>0</SaqPk>
<Sku>String</Sku>
<SkuPk>0</SkuPk>
</ShortTermRentalInventoryObj>
</Results>
</ShortTermRentalInventoryResponse>