AIM Web Services

<back to all web services

ShortTermRentalReservationRequest

ShortTermRentalReservation
Requires active-e Short Term Rental Service

The following routes are available for this service:
POST/api/ShortTermRentalReservation

// @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 ShortTermRentalReservationResponse extends BaseResponse
{
    // @DataMember
    public RefNumber: string;

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

// @DataContract
export class PackageVariantItem
{
    // @DataMember
    public Model: string;

    // @DataMember
    public Sku: string;

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

// @DataContract
export class ShortTermRentalItem
{
    /** @description SasPk, SaqPk, or PkhPk */
    // @DataMember
    // @ApiMember(Description="SasPk, SaqPk, or PkhPk", IsRequired=true, Name="Pk", ParameterType="query")
    public Pk: number;

    /** @description S for SerialNumber, P for Package deal. Empty for normal inventory. */
    // @DataMember
    // @ApiMember(Description="S for SerialNumber, P for Package deal. Empty for normal inventory.", Name="ItemType", ParameterType="query")
    public ItemType: string;

    /** @description Quantity of item required. Does not apply to serial#s. */
    // @DataMember
    // @ApiMember(Description="Quantity of item required. Does not apply to serial#s.", Name="ItemQuantity", ParameterType="query")
    public ItemQuantity?: number;

    /** @description Item rate. This is per item, so the total is this multiplied by ItemQuantity. */
    // @DataMember
    // @ApiMember(Description="Item rate. This is per item, so the total is this multiplied by ItemQuantity.", IsRequired=true, Name="ItemRate", ParameterType="query")
    public ItemRate: number;

    // @DataMember
    public Notes: string;

    // @DataMember
    public PackageVariantItems: PackageVariantItem[];

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

/** @description ShortTermRentalReservationRequires active-e Short Term Rental Service */
// @DataContract
export class ShortTermRentalReservationRequest extends BaseSecureRequest
{
    /** @description Date/Time the item is to be picked up. */
    // @DataMember
    // @ApiMember(Description="Date/Time the item is to be picked up.", IsRequired=true, Name="PickupDate", ParameterType="query")
    public PickupDate: string;

    /** @description Date/Time the item is to be returned. */
    // @DataMember
    // @ApiMember(Description="Date/Time the item is to be returned.", IsRequired=true, Name="ReturnDate", ParameterType="query")
    public ReturnDate: string;

    /** @description Account of the customer making the reservation */
    // @DataMember
    // @ApiMember(Description="Account of the customer making the reservation", IsRequired=true, Name="CustomerAcct", ParameterType="query")
    public CustomerAcct: number;

    // @DataMember
    public Items: ShortTermRentalItem[];

    // @DataMember
    public Notes: string;

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

TypeScript ShortTermRentalReservationRequest 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.

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>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <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>