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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"SlotId":0,"NumberOfPlayers":0,"NumberOfPlayersRequiringCarts":0,"NumberOfHoles":0,"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"CcInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"CustomerInfo":{"WebId":0,"Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Country":"String","Phone":"String","Email":"String"},"GuestInfo":[{"WebId":0,"Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Country":"String","Phone":"String","Email":"String"}],"CusAcct":0,"Notes":"String","GuestNotes":["String"],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}