AIM Web Services

<back to all web services

PostTeeSlotsRequest

PostTeeSlots
Requires active-e Tee-Sheet Service

The following routes are available for this service:
POST/api/PostTeeSlots
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* PostTeeSlotsRequires active-e Tee-Sheet Service
*/
@DataContract
open class PostTeeSlotsRequest : BaseSecureRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="integer", Description="", Format="int64", IsRequired=true, Name="SlotId", ParameterType="query")
    var SlotId:Long? = null

    /**
    * Number of players. Defaults to 1
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Number of players. Defaults to 1", Format="int32", Name="NumberOfPlayers", ParameterType="query")
    var NumberOfPlayers:Int? = null

    /**
    * Number of players requiring carts. Defaults to 0
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Number of players requiring carts. Defaults to 0", Format="int32", Name="NumberOfPlayersRequiringCarts", ParameterType="query")
    var NumberOfPlayersRequiringCarts:Int? = null

    /**
    * Number of holes to book. Defaults to the number of holes in the course.
    */
    @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")
    var NumberOfHoles:Int? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
    var FormInputList:ArrayList<FormInput> = ArrayList<FormInput>()

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="object", Description="", Name="CcInfo", ParameterType="query")
    var CcInfo:CcInfo? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")
    var CustomerInfo:CustomerInfo? = null

    @DataMember
    var GuestInfo:ArrayList<CustomerInfo> = ArrayList<CustomerInfo>()

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="integer", Description="", Format="int32", Name="CusAcct", ParameterType="query")
    var CusAcct:Int? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var GuestNotes:ArrayList<String> = ArrayList<String>()
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract(Name="FormInput")
open class FormInput
{
    /**
    * Field Name of the Input Field
    */
    @DataMember
    @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
    var Key:String? = null

    /**
    * Value of the Input Field.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
    var Value:String? = null

    /**
    * Whether or not the field is encryped with the C2B encryption key.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
    var Encrypted:Boolean? = null
}

@DataContract(Name="CCInfo")
open class CcInfo
{
    /**
    * Token returned from processor
    */
    @DataMember
    @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
    var TokenStr:String? = null

    /**
    * Card Type (VISA, MCARD, AMEX, DSCVR)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
    var CardType:String? = null

    /**
    * Last four of the card
    */
    @DataMember
    @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
    var LastFour:String? = null

    /**
    * Expiration Date of the Card. (MM/YY)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
    var Expiration:String? = null

    /**
    * Reason the card is on file.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    var ReasonOnFile:String? = null

    /**
    * ID of the existing Token Record in AIM, if applicable
    */
    @DataMember
    @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
    var TokenPk:Long? = null

    /**
    * Is this the customer's primary card? Defaults to false.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
    var Primary:Boolean? = null
}

@DataContract(Name="CustomerInfo")
open class CustomerInfo
{
    /**
    * The WebId of the customer. Optional.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query")
    var WebId:Int? = null

    /**
    * Name of the customer.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")
    var Name:String? = null

    /**
    * Address line 1 of the customer
    */
    @DataMember
    @ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")
    var Addr1:String? = null

    /**
    * Address line 2 of the customer
    */
    @DataMember
    @ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")
    var Addr2:String? = null

    /**
    * City of the customer
    */
    @DataMember
    @ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")
    var City:String? = null

    /**
    * State/Province of the customer
    */
    @DataMember
    @ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")
    var St:String? = null

    /**
    * Zip code of the customer
    */
    @DataMember
    @ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")
    var Zip:String? = null

    /**
    * Country of the customer
    */
    @DataMember
    @ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")
    var Country:String? = null

    /**
    * Phone number of the customer
    */
    @DataMember
    @ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")
    var Phone:String? = null

    /**
    * Email address of the customer. Required.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
    var Email:String? = null
}

@DataContract
open class PostTeeSlotsResponse : BaseResponse()
{
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

Kotlin PostTeeSlotsRequest 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/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>