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
PostTeeSlotsRequest Parameters:
NameParameterData TypeRequiredDescription
SlotIdqueryintegerYes
NumberOfPlayersqueryintegerNoNumber of players. Defaults to 1
NumberOfPlayersRequiringCartsqueryintegerNoNumber of players requiring carts. Defaults to 0
NumberOfHolesqueryintegerNoNumber of holes to book. Defaults to the number of holes in the course.
FormInputListqueryarrayNo
CcInfoqueryobjectNo
CustomerInfoqueryobjectNo
GuestInfobodyList<CustomerInfo>No
CusAcctqueryintegerNo
NotesbodystringNo
GuestNotesbodyList<string>No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
FormInput Parameters:
NameParameterData TypeRequiredDescription
KeyquerystringYesField Name of the Input Field
ValuequerystringYesValue of the Input Field.
EncryptedquerybooleanYesWhether or not the field is encryped with the C2B encryption key.
CcInfo Parameters:
NameParameterData TypeRequiredDescription
TokenStrquerystringYesToken returned from processor
CardTypequerystringYesCard Type (VISA, MCARD, AMEX, DSCVR)
LastFourquerystringYesLast four of the card
ExpirationquerystringNoExpiration Date of the Card. (MM/YY)
ReasonOnFilequerystringNoReason the card is on file.
TokenPkqueryintegerNoID of the existing Token Record in AIM, if applicable
PrimaryquerybooleanNoIs this the customer's primary card? Defaults to false.
CustomerInfo Parameters:
NameParameterData TypeRequiredDescription
WebIdqueryintegerYesThe WebId of the customer. Optional.
NamequerystringYesName of the customer.
Addr1querystringNoAddress line 1 of the customer
Addr2querystringNoAddress line 2 of the customer
CityquerystringNoCity of the customer
StquerystringNoState/Province of the customer
ZipquerystringNoZip code of the customer
CountryquerystringNoCountry of the customer
PhonequerystringNoPhone number of the customer
EmailquerystringYesEmail address of the customer. Required.
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo

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>