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

<GetTimeSlotsRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <Location>String</Location>
  <ShowOpenSlots>false</ShowOpenSlots>
  <ShowReservedSlots>false</ShowReservedSlots>
  <TimeFrom>0001-01-01T00:00:00</TimeFrom>
  <TimeTo>0001-01-01T00:00:00</TimeTo>
  <Type>String</Type>
</GetTimeSlotsRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTimeSlotsResponse 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>
  <TimeSlots xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:TimeSlotGeneric>
      <d2p1:DateTime>0001-01-01T00:00:00</d2p1:DateTime>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Location>String</d2p1:Location>
      <d2p1:SlotsOpen>0</d2p1:SlotsOpen>
      <d2p1:Type>String</d2p1:Type>
    </d2p1:TimeSlotGeneric>
  </TimeSlots>
</GetTimeSlotsResponse>