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.*;

public class dtos
{

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

        /**
        * Number of players. Defaults to 1
        */
        @DataMember
        @ApiMember(DataType="integer", Description="Number of players. Defaults to 1", Format="int32", Name="NumberOfPlayers", ParameterType="query")
        public Integer NumberOfPlayers = 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")
        public Integer NumberOfPlayersRequiringCarts = 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")
        public Integer NumberOfHoles = null;

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="object", Description="", Name="CcInfo", ParameterType="query")
        public CcInfo CcInfo = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")
        public CustomerInfo CustomerInfo = null;

        @DataMember
        public ArrayList<CustomerInfo> GuestInfo = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="integer", Description="", Format="int32", Name="CusAcct", ParameterType="query")
        public Integer CusAcct = null;

        @DataMember
        public String Notes = null;

        @DataMember
        public ArrayList<String> GuestNotes = null;
        
        public Long getSlotId() { return SlotId; }
        public PostTeeSlotsRequest setSlotId(Long value) { this.SlotId = value; return this; }
        public Integer getNumberOfPlayers() { return NumberOfPlayers; }
        public PostTeeSlotsRequest setNumberOfPlayers(Integer value) { this.NumberOfPlayers = value; return this; }
        public Integer getNumberOfPlayersRequiringCarts() { return NumberOfPlayersRequiringCarts; }
        public PostTeeSlotsRequest setNumberOfPlayersRequiringCarts(Integer value) { this.NumberOfPlayersRequiringCarts = value; return this; }
        public Integer getNumberOfHoles() { return NumberOfHoles; }
        public PostTeeSlotsRequest setNumberOfHoles(Integer value) { this.NumberOfHoles = value; return this; }
        public ArrayList<FormInput> getFormInputList() { return FormInputList; }
        public PostTeeSlotsRequest setFormInputList(ArrayList<FormInput> value) { this.FormInputList = value; return this; }
        public CcInfo getCcInfo() { return CcInfo; }
        public PostTeeSlotsRequest setCcInfo(CcInfo value) { this.CcInfo = value; return this; }
        public CustomerInfo getCustomerInfo() { return CustomerInfo; }
        public PostTeeSlotsRequest setCustomerInfo(CustomerInfo value) { this.CustomerInfo = value; return this; }
        public ArrayList<CustomerInfo> getGuestInfo() { return GuestInfo; }
        public PostTeeSlotsRequest setGuestInfo(ArrayList<CustomerInfo> value) { this.GuestInfo = value; return this; }
        public Integer getCusAcct() { return CusAcct; }
        public PostTeeSlotsRequest setCusAcct(Integer value) { this.CusAcct = value; return this; }
        public String getNotes() { return Notes; }
        public PostTeeSlotsRequest setNotes(String value) { this.Notes = value; return this; }
        public ArrayList<String> getGuestNotes() { return GuestNotes; }
        public PostTeeSlotsRequest setGuestNotes(ArrayList<String> value) { this.GuestNotes = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static 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")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract(Name="FormInput")
    public static 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")
        public String Key = null;

        /**
        * Value of the Input Field.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
        public String Value = 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")
        public Boolean Encrypted = null;
        
        public String getKey() { return Key; }
        public FormInput setKey(String value) { this.Key = value; return this; }
        public String getValue() { return Value; }
        public FormInput setValue(String value) { this.Value = value; return this; }
        public Boolean isEncrypted() { return Encrypted; }
        public FormInput setEncrypted(Boolean value) { this.Encrypted = value; return this; }
    }

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

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

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

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

        /**
        * Reason the card is on file.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
        public String ReasonOnFile = 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")
        public Long TokenPk = 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")
        public Boolean Primary = null;
        
        public String getTokenStr() { return TokenStr; }
        public CcInfo setTokenStr(String value) { this.TokenStr = value; return this; }
        public String getCardType() { return CardType; }
        public CcInfo setCardType(String value) { this.CardType = value; return this; }
        public String getLastFour() { return LastFour; }
        public CcInfo setLastFour(String value) { this.LastFour = value; return this; }
        public String getExpiration() { return Expiration; }
        public CcInfo setExpiration(String value) { this.Expiration = value; return this; }
        public String getReasonOnFile() { return ReasonOnFile; }
        public CcInfo setReasonOnFile(String value) { this.ReasonOnFile = value; return this; }
        public Long getTokenPk() { return TokenPk; }
        public CcInfo setTokenPk(Long value) { this.TokenPk = value; return this; }
        public Boolean isPrimary() { return Primary; }
        public CcInfo setPrimary(Boolean value) { this.Primary = value; return this; }
    }

    @DataContract(Name="CustomerInfo")
    public static 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")
        public Integer WebId = null;

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

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

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

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

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

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

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

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

        /**
        * Email address of the customer. Required.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
        public String Email = null;
        
        public Integer getWebId() { return WebId; }
        public CustomerInfo setWebId(Integer value) { this.WebId = value; return this; }
        public String getName() { return Name; }
        public CustomerInfo setName(String value) { this.Name = value; return this; }
        public String getAddr1() { return Addr1; }
        public CustomerInfo setAddr1(String value) { this.Addr1 = value; return this; }
        public String getAddr2() { return Addr2; }
        public CustomerInfo setAddr2(String value) { this.Addr2 = value; return this; }
        public String getCity() { return City; }
        public CustomerInfo setCity(String value) { this.City = value; return this; }
        public String getSt() { return St; }
        public CustomerInfo setSt(String value) { this.St = value; return this; }
        public String getZip() { return Zip; }
        public CustomerInfo setZip(String value) { this.Zip = value; return this; }
        public String getCountry() { return Country; }
        public CustomerInfo setCountry(String value) { this.Country = value; return this; }
        public String getPhone() { return Phone; }
        public CustomerInfo setPhone(String value) { this.Phone = value; return this; }
        public String getEmail() { return Email; }
        public CustomerInfo setEmail(String value) { this.Email = value; return this; }
    }

    @DataContract
    public static class PostTeeSlotsResponse extends BaseResponse
    {
        
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

}

Java 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>