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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract(Name="CCInfo")]
    public partial class CcInfo
    {
        ///<summary>
        ///Token returned from processor
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")]
        public virtual string TokenStr { get; set; }

        ///<summary>
        ///Card Type (VISA, MCARD, AMEX, DSCVR)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")]
        public virtual string CardType { get; set; }

        ///<summary>
        ///Last four of the card
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")]
        public virtual string LastFour { get; set; }

        ///<summary>
        ///Expiration Date of the Card. (MM/YY)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")]
        public virtual string Expiration { get; set; }

        ///<summary>
        ///Reason the card is on file.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")]
        public virtual string ReasonOnFile { get; set; }

        ///<summary>
        ///ID of the existing Token Record in AIM, if applicable
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")]
        public virtual long? TokenPk { get; set; }

        ///<summary>
        ///Is this the customer's primary card? Defaults to false.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")]
        public virtual bool? Primary { get; set; }
    }

    [DataContract(Name="CustomerInfo")]
    public partial class CustomerInfo
    {
        ///<summary>
        ///The WebId of the customer. Optional.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query")]
        public virtual int? WebId { get; set; }

        ///<summary>
        ///Name of the customer.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")]
        public virtual string Name { get; set; }

        ///<summary>
        ///Address line 1 of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")]
        public virtual string Addr1 { get; set; }

        ///<summary>
        ///Address line 2 of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")]
        public virtual string Addr2 { get; set; }

        ///<summary>
        ///City of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")]
        public virtual string City { get; set; }

        ///<summary>
        ///State/Province of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")]
        public virtual string St { get; set; }

        ///<summary>
        ///Zip code of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")]
        public virtual string Zip { get; set; }

        ///<summary>
        ///Country of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")]
        public virtual string Country { get; set; }

        ///<summary>
        ///Phone number of the customer
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")]
        public virtual string Phone { get; set; }

        ///<summary>
        ///Email address of the customer. Required.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")]
        public virtual string Email { get; set; }
    }

    ///<summary>
    ///StationReservationRequires active-e Station Reservations Service
    ///</summary>
    [DataContract]
    public partial class StationReservationRequest
        : BaseSecureRequest
    {
        ///<summary>
        ///The ID of the station being reserved
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The ID of the station being reserved", Format="int64", IsRequired=true, Name="StationId", ParameterType="query")]
        public virtual long StationId { get; set; }

        ///<summary>
        ///The Customer Acct assosicated with the reservation. Either this or CustomerInfo is required.
        ///</summary>
        [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 virtual int? Acct { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")]
        public virtual CustomerInfo CustomerInfo { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="object", Description="", Name="CcInfo ", ParameterType="query")]
        public virtual CcInfo CcInfo { get; set; }

        ///<summary>
        ///The start date/time of the reservation.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The start date/time of the reservation.", Format="date-time", IsRequired=true, Name="Start", ParameterType="query")]
        public virtual DateTime Start { get; set; }

        ///<summary>
        ///The length (in minutes) of the reservation.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The length (in minutes) of the reservation.", Format="int32", IsRequired=true, Name="Length", ParameterType="query")]
        public virtual int Length { get; set; }

        ///<summary>
        ///Number of guests (in addition to the customer) included in this reservation. Defaults to 0.
        ///</summary>
        [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 virtual int Guests { get; set; }

        ///<summary>
        ///Notes
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Notes", Name="Notes", ParameterType="query")]
        public virtual string Notes { get; set; }
    }

    [DataContract]
    public partial class StationReservationResponse
        : BaseResponse
    {
    }

}

C# 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>