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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type StationReservationResponse() = 
        inherit BaseResponse()

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    [<DataContract(Name="CustomerInfo")>]
    [<AllowNullLiteral>]
    type 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")>]
        member val WebId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///Name of the customer.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")>]
        member val Name:String = null with 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")>]
        member val Addr1:String = null with 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")>]
        member val Addr2:String = null with get,set

        ///<summary>
        ///City of the customer
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")>]
        member val City:String = null with get,set

        ///<summary>
        ///State/Province of the customer
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")>]
        member val St:String = null with get,set

        ///<summary>
        ///Zip code of the customer
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")>]
        member val Zip:String = null with get,set

        ///<summary>
        ///Country of the customer
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")>]
        member val Country:String = null with get,set

        ///<summary>
        ///Phone number of the customer
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")>]
        member val Phone:String = null with 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")>]
        member val Email:String = null with get,set

    [<DataContract(Name="CCInfo")>]
    [<AllowNullLiteral>]
    type CcInfo() = 
        ///<summary>
        ///Token returned from processor
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")>]
        member val TokenStr:String = null with 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")>]
        member val CardType:String = null with 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")>]
        member val LastFour:String = null with 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")>]
        member val Expiration:String = null with 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")>]
        member val ReasonOnFile:String = null with 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")>]
        member val TokenPk:Nullable<Int64> = new Nullable<Int64>() with 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")>]
        member val Primary:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    ///<summary>
    ///StationReservationRequires active-e Station Reservations Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type StationReservationRequest() = 
        inherit 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")>]
        member val StationId:Int64 = new Int64() with 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")>]
        member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")>]
        member val CustomerInfo:CustomerInfo = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="object", Description="", Name="CcInfo ", ParameterType="query")>]
        member val CcInfo:CcInfo = null with 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")>]
        member val Start:DateTime = new DateTime() with 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")>]
        member val Length:Int32 = new Int32() with 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")>]
        member val Guests:Int32 = new Int32() with get,set

        ///<summary>
        ///Notes
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Notes", Name="Notes", ParameterType="query")>]
        member val Notes:String = null with get,set

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