AIM Web Services

<back to all web services

GetTeeSlotsRequest

GetTeeSlots
Requires active-e Tee-Sheet Service

The following routes are available for this service:
POST, GET/api/GetTeeSlots
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class TeeSlotGeneric
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property DateTime As Date

            <DataMember>
            Public Overridable Property Cost As Decimal

            <DataMember>
            Public Overridable Property Cost2 As Decimal

            <DataMember>
            Public Overridable Property Cost3 As Decimal

            <DataMember>
            Public Overridable Property SlotsOpen As Integer

            <DataMember>
            Public Overridable Property MinSlots As Integer

            <DataMember>
            Public Overridable Property Course As String

            <DataMember>
            Public Overridable Property CourseTopic As String

            <DataMember>
            Public Overridable Property Location As String

            <DataMember>
            Public Overridable Property Note As String

            <DataMember>
            Public Overridable Property Has18Holes As Boolean

            <DataMember>
            Public Overridable Property WebId As String

            <DataMember>
            Public Overridable Property StartingOnBack9 As Boolean
        End Class
    End Namespace

    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

        '''<Summary>
        '''GetTeeSlotsRequires active-e Tee-Sheet Service
        '''</Summary>
        <DataContract>
        Public Partial Class GetTeeSlotsRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property DateFrom As Date

            <DataMember>
            Public Overridable Property DateTo As Date

            <DataMember>
            Public Overridable Property TimeFrom As Nullable(Of Date)

            <DataMember>
            Public Overridable Property TimeTo As Nullable(Of Date)

            <DataMember>
            Public Overridable Property Course As String

            <DataMember>
            Public Overridable Property Location As String

            <DataMember>
            Public Overridable Property WebId As String

            <DataMember>
            Public Overridable Property SlotsRequired As Nullable(Of Long)

            <DataMember>
            Public Overridable Property ShowOpenSlots As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property ShowReservedSlots As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property Show9HoleSlots As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property Show18HoleSlots As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property ShowFront9 As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property ShowBack9 As Nullable(Of Boolean)
        End Class

        <DataContract>
        Public Partial Class GetTeeSlotsResponse
            Inherits BaseResponse
            Public Sub New()
                TeeSlots = New List(Of TeeSlotGeneric)
            End Sub

            <DataMember>
            Public Overridable Property TeeSlots As List(Of TeeSlotGeneric)
        End Class
    End Namespace
End Namespace

VB.NET GetTeeSlotsRequest 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/GetTeeSlots HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GetTeeSlotsRequest 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>
  <Course>String</Course>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <Location>String</Location>
  <Show18HoleSlots>false</Show18HoleSlots>
  <Show9HoleSlots>false</Show9HoleSlots>
  <ShowBack9>false</ShowBack9>
  <ShowFront9>false</ShowFront9>
  <ShowOpenSlots>false</ShowOpenSlots>
  <ShowReservedSlots>false</ShowReservedSlots>
  <SlotsRequired>0</SlotsRequired>
  <TimeFrom>0001-01-01T00:00:00</TimeFrom>
  <TimeTo>0001-01-01T00:00:00</TimeTo>
  <WebId>String</WebId>
</GetTeeSlotsRequest>

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

<GetTeeSlotsResponse 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>
  <TeeSlots xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:TeeSlotGeneric>
      <d2p1:Cost>0</d2p1:Cost>
      <d2p1:Cost2>0</d2p1:Cost2>
      <d2p1:Cost3>0</d2p1:Cost3>
      <d2p1:Course>String</d2p1:Course>
      <d2p1:CourseTopic>String</d2p1:CourseTopic>
      <d2p1:DateTime>0001-01-01T00:00:00</d2p1:DateTime>
      <d2p1:Has18Holes>false</d2p1:Has18Holes>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Location>String</d2p1:Location>
      <d2p1:MinSlots>0</d2p1:MinSlots>
      <d2p1:Note>String</d2p1:Note>
      <d2p1:SlotsOpen>0</d2p1:SlotsOpen>
      <d2p1:StartingOnBack9>false</d2p1:StartingOnBack9>
      <d2p1:WebId>String</d2p1:WebId>
    </d2p1:TeeSlotGeneric>
  </TeeSlots>
</GetTeeSlotsResponse>