AIM Web Services

<back to all web services

ShortTermRentalInventoryRequest

ShortTermRentalInventory
Requires active-e Short Term Rental Service

The following routes are available for this service:
GET/api/ShortTermRentalInventory
ShortTermRentalInventoryRequest Parameters:
NameParameterData TypeRequiredDescription
ItemquerystringNoItem to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory
LocationCodequerystringNo
ItemPkquerylong?NoKey of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory
PkTypequerystringNoType 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
Categoryqueryint?NoPass in either SubCategory + this *OR* Item *OR* ItemPk + PkType
SubCategoryqueryint?NoPass in either Category + this *OR* Item *OR* ItemPk + PkType
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNoThe Login Token return by the Security API. Required for secured calls.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyHeaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenHeaderstringYesThe OAuthToken token return by AeServices30
DeviceIdHeaderstringNoThe Device ID of the Mobile Device. Not used for non-mobile devices.
AppIdHeaderstringYesAn identifier for your integration
ShortTermRentalInventoryResponse Parameters:
NameParameterData TypeRequiredDescription
ResultsformList<ShortTermRentalInventoryObj>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
ShortTermRentalInventoryObj Parameters:
NameParameterData TypeRequiredDescription
RatesformList<ShortTermRentalInventoryRate>No
AvailableSerialPksformList<long>No
SaqPkformlong?No
SkuPkformlong?No
PkhPkformlong?No
SkuformstringNo
PackageformstringNo
InvTypeformstringNo
AvailableQtyformdecimalNo
ShortTermRentalInventoryRate Parameters:
NameParameterData TypeRequiredDescription
HeaderDescformstringNo
HeaderNotesformstringNo
DescformstringNo
IntervalTypeformstringNo
GroupformstringNo
NotesformstringNo
AmtformdecimalNo
TimeIntervalformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>