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

// @DataContract
export class BaseRequest
{
    /** @description This is your AIM API Key provided by Tri-Tech */
    // @DataMember
    // @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ShortTermRentalInventoryRate
{
    // @DataMember
    public HeaderDesc: string;

    // @DataMember
    public HeaderNotes: string;

    // @DataMember
    public Desc: string;

    // @DataMember
    public IntervalType: string;

    // @DataMember
    public Group: string;

    // @DataMember
    public Notes: string;

    // @DataMember
    public Amt: number;

    // @DataMember
    public TimeInterval: number;

    public constructor(init?: Partial<ShortTermRentalInventoryRate>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ShortTermRentalInventoryObj
{
    // @DataMember
    public Rates: ShortTermRentalInventoryRate[];

    // @DataMember
    public AvailableSerialPks: number[];

    // @DataMember
    public SaqPk?: number;

    // @DataMember
    public SkuPk?: number;

    // @DataMember
    public PkhPk?: number;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Package: string;

    // @DataMember
    public InvType: string;

    // @DataMember
    public AvailableQty: number;

    public constructor(init?: Partial<ShortTermRentalInventoryObj>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ShortTermRentalInventoryResponse extends BaseResponse
{
    // @DataMember
    public Results: ShortTermRentalInventoryObj[];

    public constructor(init?: Partial<ShortTermRentalInventoryResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description ShortTermRentalInventoryRequires active-e Short Term Rental Service */
// @DataContract
export class ShortTermRentalInventoryRequest extends BaseSecureRequest
{
    /** @description Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory */
    // @DataMember
    // @ApiMember(Description="Item to lookup. Pass in either this *OR* ItemPk + PkType *OR* Category + SubCategory", Name="Item", ParameterType="query")
    public Item: string;

    // @DataMember
    public LocationCode: string;

    /** @description Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory */
    // @DataMember
    // @ApiMember(Description="Key of the item to lookup. Pass in either this plus PkType *OR* Item *OR* Category + SubCategory", Name="ItemPk", ParameterType="query")
    public ItemPk?: number;

    /** @description 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 */
    // @DataMember
    // @ApiMember(Description="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", Name="PkType", ParameterType="query")
    public PkType: string;

    /** @description Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType */
    // @DataMember
    // @ApiMember(Description="Pass in either SubCategory + this *OR* Item *OR* ItemPk + PkType", Name="Category", ParameterType="query")
    public Category?: number;

    /** @description Pass in either Category + this *OR* Item *OR* ItemPk + PkType */
    // @DataMember
    // @ApiMember(Description="Pass in either Category + this *OR* Item *OR* ItemPk + PkType", Name="SubCategory", ParameterType="query")
    public SubCategory?: number;

    public constructor(init?: Partial<ShortTermRentalInventoryRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript ShortTermRentalInventoryRequest DTOs

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>