| POST | /api/PostTeeSlots |
|---|
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
<DataContract(Name:="FormInput")>
Public Partial Class FormInput
'''<Summary>
'''Field Name of the Input Field
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Field Name of the Input Field", IsRequired:=true, Name:="Key", ParameterType:="query")>
Public Overridable Property Key As String
'''<Summary>
'''Value of the Input Field.
'''</Summary>
<DataMember>
<ApiMember(DataType:="string", Description:="Value of the Input Field.", IsRequired:=true, Name:="Value", ParameterType:="query")>
Public Overridable Property Value As String
'''<Summary>
'''Whether or not the field is encryped with the C2B encryption key.
'''</Summary>
<DataMember>
<ApiMember(DataType:="boolean", Description:="Whether or not the field is encryped with the C2B encryption key.", IsRequired:=true, Name:="Encrypted", ParameterType:="query")>
Public Overridable Property Encrypted As Boolean
End Class
'''<Summary>
'''PostTeeSlotsRequires active-e Tee-Sheet Service
'''</Summary>
<DataContract>
Public Partial Class PostTeeSlotsRequest
Inherits BaseSecureRequest
Public Sub New()
FormInputList = New List(Of FormInput)
GuestInfo = New List(Of CustomerInfo)
GuestNotes = New List(Of String)
End Sub
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="integer", Description:="", Format:="int64", IsRequired:=true, Name:="SlotId", ParameterType:="query")>
Public Overridable Property SlotId As Nullable(Of Long)
'''<Summary>
'''Number of players. Defaults to 1
'''</Summary>
<DataMember>
<ApiMember(DataType:="integer", Description:="Number of players. Defaults to 1", Format:="int32", Name:="NumberOfPlayers", ParameterType:="query")>
Public Overridable Property NumberOfPlayers As Nullable(Of Integer)
'''<Summary>
'''Number of players requiring carts. Defaults to 0
'''</Summary>
<DataMember>
<ApiMember(DataType:="integer", Description:="Number of players requiring carts. Defaults to 0", Format:="int32", Name:="NumberOfPlayersRequiringCarts", ParameterType:="query")>
Public Overridable Property NumberOfPlayersRequiringCarts As Nullable(Of Integer)
'''<Summary>
'''Number of holes to book. Defaults to the number of holes in the course.
'''</Summary>
<DataMember>
<ApiMember(DataType:="integer", Description:="Number of holes to book. Defaults to the number of holes in the course.", Format:="int32", Name:="NumberOfHoles", ParameterType:="query")>
Public Overridable Property NumberOfHoles As Nullable(Of Integer)
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="array", Description:="", Name:="FormInputList", ParameterType:="query")>
Public Overridable Property FormInputList As List(Of FormInput)
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="object", Description:="", Name:="CcInfo", ParameterType:="query")>
Public Overridable Property CcInfo As CcInfo
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="object", Description:="", Name:="CustomerInfo", ParameterType:="query")>
Public Overridable Property CustomerInfo As CustomerInfo
<DataMember>
Public Overridable Property GuestInfo As List(Of CustomerInfo)
'''<Summary>
'''
'''</Summary>
<DataMember>
<ApiMember(DataType:="integer", Description:="", Format:="int32", Name:="CusAcct", ParameterType:="query")>
Public Overridable Property CusAcct As Nullable(Of Integer)
<DataMember>
Public Overridable Property Notes As String
<DataMember>
Public Overridable Property GuestNotes As List(Of String)
End Class
<DataContract>
Public Partial Class PostTeeSlotsResponse
Inherits BaseResponse
End Class
End Namespace
End Namespace
VB.NET PostTeeSlotsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/PostTeeSlots HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PostTeeSlotsRequest 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>
<CcInfo>
<CardType>String</CardType>
<Expiration>String</Expiration>
<LastFour>String</LastFour>
<Primary>false</Primary>
<ReasonOnFile>String</ReasonOnFile>
<TokenPk>0</TokenPk>
<TokenStr>String</TokenStr>
</CcInfo>
<CusAcct>0</CusAcct>
<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>
<FormInputList>
<FormInput>
<Encrypted>false</Encrypted>
<Key>String</Key>
<Value>String</Value>
</FormInput>
</FormInputList>
<GuestInfo>
<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>
</GuestInfo>
<GuestNotes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</GuestNotes>
<Notes>String</Notes>
<NumberOfHoles>0</NumberOfHoles>
<NumberOfPlayers>0</NumberOfPlayers>
<NumberOfPlayersRequiringCarts>0</NumberOfPlayersRequiringCarts>
<SlotId>0</SlotId>
</PostTeeSlotsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PostTeeSlotsResponse 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>
</PostTeeSlotsResponse>