| POST | /api/StationReservation |
|---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Namespace Global
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 Overridable Property ApiKey As String
<DataMember>
<ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
Public Overridable Property OAuthToken As String
End Class
<DataContract>
Public Partial Class BaseResponse
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
Public Overridable Property Status As BaseResponseResult
<DataContract>
Public Partial Class BaseResponseResult
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
Public Overridable Property StatusCode As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
Public Overridable Property Login As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
Public Overridable Property ErrorCode As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
Public Overridable Property ErrorDisplayText As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
Public Overridable Property ErrorMessage As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
Public Overridable Property DomainName As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
Public Overridable Property IpAddress As String
End Class
End Class
<DataContract>
Public Partial Class BaseSecureRequest
Inherits BaseRequest
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
Public Overridable Property Token As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
Public Overridable Property DeviceId As String
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
Public Overridable Property AppId As String
End Class
<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 Overridable Property TokenStr As String
'''<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 Overridable Property CardType As String
'''<Summary>
'''Last four of the card
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Last four of the card", IsRequired:=true, Name:="LastFour", ParameterType:="query")>
Public Overridable Property LastFour As String
'''<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 Overridable Property Expiration As String
'''<Summary>
'''Reason the card is on file.
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Reason the card is on file.", Name:="ReasonOnFile", ParameterType:="query")>
Public Overridable Property ReasonOnFile As String
'''<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 Overridable Property TokenPk As Nullable(Of Long)
'''<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 Overridable Property Primary As Nullable(Of Boolean)
End Class
<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 Overridable Property WebId As Nullable(Of Integer)
'''<Summary>
'''Name of the customer.
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Name of the customer.", IsRequired:=true, Name:="Name", ParameterType:="query")>
Public Overridable Property Name As String
'''<Summary>
'''Address line 1 of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Address line 1 of the customer", Name:="Addr1", ParameterType:="query")>
Public Overridable Property Addr1 As String
'''<Summary>
'''Address line 2 of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Address line 2 of the customer", Name:="Addr2", ParameterType:="query")>
Public Overridable Property Addr2 As String
'''<Summary>
'''City of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="City of the customer", Name:="City", ParameterType:="query")>
Public Overridable Property City As String
'''<Summary>
'''State/Province of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="State/Province of the customer", Name:="St", ParameterType:="query")>
Public Overridable Property St As String
'''<Summary>
'''Zip code of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Zip code of the customer", Name:="Zip", ParameterType:="query")>
Public Overridable Property Zip As String
'''<Summary>
'''Country of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Country of the customer", Name:="Country", ParameterType:="query")>
Public Overridable Property Country As String
'''<Summary>
'''Phone number of the customer
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Phone number of the customer", Name:="Phone", ParameterType:="query")>
Public Overridable Property Phone As String
'''<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 Overridable Property Email As String
End Class
'''<Summary>
'''StationReservationRequires active-e Station Reservations Service
'''</Summary>
<DataContract>
Public Partial Class StationReservationRequest
Inherits 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 Overridable Property StationId As Long
'''<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 Overridable Property Acct As Nullable(Of Integer)
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="object", Description:="", Name:="CustomerInfo", ParameterType:="query")>
Public Overridable Property CustomerInfo As CustomerInfo
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="object", Description:="", Name:="CcInfo ", ParameterType:="query")>
Public Overridable Property CcInfo As CcInfo
'''<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 Overridable Property Start As Date
'''<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 Overridable Property Length As Integer
'''<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 Overridable Property Guests As Integer
'''<Summary>
'''Notes
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Notes", Name:="Notes", ParameterType:="query")>
Public Overridable Property Notes As String
End Class
<DataContract>
Public Partial Class StationReservationResponse
Inherits BaseResponse
End Class
End Namespace
End Namespace
VB.NET StationReservationRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"StationId":0,"Acct":0,"CustomerInfo":{"WebId":0,"Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Country":"String","Phone":"String","Email":"String"},"CcInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"Length":0,"Guests":0,"Notes":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}