AIM Web Services

<back to all web services

StationReservationRequest

StationReservation
Requires active-e Station Reservations Service

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

// @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 StationReservationResponse extends BaseResponse
{

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

// @DataContract(Name="CustomerInfo")
export class CustomerInfo
{
    /** @description The WebId of the customer. Optional. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query")
    public WebId: number;

    /** @description Name of the customer. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")
    public Name: string;

    /** @description Address line 1 of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")
    public Addr1: string;

    /** @description Address line 2 of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")
    public Addr2: string;

    /** @description City of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")
    public City: string;

    /** @description State/Province of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")
    public St: string;

    /** @description Zip code of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")
    public Zip: string;

    /** @description Country of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")
    public Country: string;

    /** @description Phone number of the customer */
    // @DataMember
    // @ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")
    public Phone: string;

    /** @description Email address of the customer. Required. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
    public Email: string;

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

// @DataContract(Name="CCInfo")
export class CcInfo
{
    /** @description Token returned from processor */
    // @DataMember
    // @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
    public TokenStr: string;

    /** @description Card Type (VISA, MCARD, AMEX, DSCVR) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
    public CardType: string;

    /** @description Last four of the card */
    // @DataMember
    // @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
    public LastFour: string;

    /** @description Expiration Date of the Card. (MM/YY) */
    // @DataMember
    // @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
    public Expiration: string;

    /** @description Reason the card is on file. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    public ReasonOnFile: string;

    /** @description ID of the existing Token Record in AIM, if applicable */
    // @DataMember
    // @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
    public TokenPk?: number;

    /** @description Is this the customer's primary card? Defaults to false. */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
    public Primary?: boolean;

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

/** @description StationReservationRequires active-e Station Reservations Service */
// @DataContract
export class StationReservationRequest extends BaseSecureRequest
{
    /** @description The ID of the station being reserved */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The ID of the station being reserved", Format="int64", IsRequired=true, Name="StationId", ParameterType="query")
    public StationId: number;

    /** @description The Customer Acct assosicated with the reservation. Either this or CustomerInfo is required. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The Customer Acct assosicated with the reservation. Either this or CustomerInfo is required.", Format="int32", Name="Acct", ParameterType="query")
    public Acct?: number;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")
    public CustomerInfo: CustomerInfo;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="object", Description="", Name="CcInfo ", ParameterType="query")
    public CcInfo: CcInfo;

    /** @description The start date/time of the reservation. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The start date/time of the reservation.", Format="date-time", IsRequired=true, Name="Start", ParameterType="query")
    public Start: string;

    /** @description The length (in minutes) of the reservation. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The length (in minutes) of the reservation.", Format="int32", IsRequired=true, Name="Length", ParameterType="query")
    public Length: number;

    /** @description Number of guests (in addition to the customer) included in this reservation. Defaults to 0. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="Number of guests (in addition to the customer) included in this reservation. Defaults to 0.", Format="int32", Name="Guests", ParameterType="query")
    public Guests: number;

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

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

TypeScript StationReservationRequest 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/StationReservation HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<StationReservationRequest 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>
  <Acct>0</Acct>
  <CcInfo>
    <CardType>String</CardType>
    <Expiration>String</Expiration>
    <LastFour>String</LastFour>
    <Primary>false</Primary>
    <ReasonOnFile>String</ReasonOnFile>
    <TokenPk>0</TokenPk>
    <TokenStr>String</TokenStr>
  </CcInfo>
  <CustomerInfo>
    <Addr1>String</Addr1>
    <Addr2>String</Addr2>
    <City>String</City>
    <Country>String</Country>
    <Email>String</Email>
    <Name>String</Name>
    <Phone>String</Phone>
    <St>String</St>
    <WebId>0</WebId>
    <Zip>String</Zip>
  </CustomerInfo>
  <Guests>0</Guests>
  <Length>0</Length>
  <Notes>String</Notes>
  <Start>0001-01-01T00:00:00</Start>
  <StationId>0</StationId>
</StationReservationRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StationReservationResponse 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>
</StationReservationResponse>