AIM Web Services

<back to all web services

GetTimeSlotsRequest

GetTimeSlots
Requires active-e Contracts Service, active-e Service Ticket Service, active-e Lesson Scheduling Service, active-e Vortx E-Commerce Service, or active-e 3rd Party E-Commerce Service

The following routes are available for this service:
POST, GET/api/GetTimeSlots
GetTimeSlotsRequest Parameters:
NameParameterData TypeRequiredDescription
DateFrombodyDateTimeNo
DateTobodyDateTimeNo
TimeFrombodyDateTime?No
TimeTobodyDateTime?No
LocationbodystringNo
ShowOpenSlotsbodybool?No
ShowReservedSlotsbodybool?No
TypequerystringNoIf sent, only Time Slots of the sent type are returned. Valid options are STORE and DELIVERY.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
GetTimeSlotsResponse Parameters:
NameParameterData TypeRequiredDescription
TimeSlotsformList<TimeSlotGeneric>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
TimeSlotGeneric Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
DateTimeformDateTimeNo
SlotsOpenformintNo
LocationformstringNo
TypeformstringNo

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/GetTimeSlots HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"TimeFrom":"0001-01-01T00:00:00.0000000","TimeTo":"0001-01-01T00:00:00.0000000","Location":"String","ShowOpenSlots":false,"ShowReservedSlots":false,"Type":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"TimeSlots":[{"Id":0,"SlotsOpen":0,"Location":"String","Type":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}