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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * GetTimeSlotsRequires 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
    */
    @DataContract
    public static class GetTimeSlotsRequest extends BaseRequest
    {
        @DataMember
        public Date DateFrom = null;

        @DataMember
        public Date DateTo = null;

        @DataMember
        public Date TimeFrom = null;

        @DataMember
        public Date TimeTo = null;

        @DataMember
        public String Location = null;

        @DataMember
        public Boolean ShowOpenSlots = null;

        @DataMember
        public Boolean ShowReservedSlots = null;

        /**
        * If sent, only Time Slots of the sent type are returned. Valid options are STORE and DELIVERY.
        */
        @DataMember
        @ApiMember(DataType="string", Description="If sent, only Time Slots of the sent type are returned. Valid options are STORE and DELIVERY.", Name="Type", ParameterType="query")
        public String Type = null;
        
        public Date getDateFrom() { return DateFrom; }
        public GetTimeSlotsRequest setDateFrom(Date value) { this.DateFrom = value; return this; }
        public Date getDateTo() { return DateTo; }
        public GetTimeSlotsRequest setDateTo(Date value) { this.DateTo = value; return this; }
        public Date getTimeFrom() { return TimeFrom; }
        public GetTimeSlotsRequest setTimeFrom(Date value) { this.TimeFrom = value; return this; }
        public Date getTimeTo() { return TimeTo; }
        public GetTimeSlotsRequest setTimeTo(Date value) { this.TimeTo = value; return this; }
        public String getLocation() { return Location; }
        public GetTimeSlotsRequest setLocation(String value) { this.Location = value; return this; }
        public Boolean isShowOpenSlots() { return ShowOpenSlots; }
        public GetTimeSlotsRequest setShowOpenSlots(Boolean value) { this.ShowOpenSlots = value; return this; }
        public Boolean isShowReservedSlots() { return ShowReservedSlots; }
        public GetTimeSlotsRequest setShowReservedSlots(Boolean value) { this.ShowReservedSlots = value; return this; }
        public String getType() { return Type; }
        public GetTimeSlotsRequest setType(String value) { this.Type = 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
    public static class GetTimeSlotsResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<TimeSlotGeneric> TimeSlots = null;
        
        public ArrayList<TimeSlotGeneric> getTimeSlots() { return TimeSlots; }
        public GetTimeSlotsResponse setTimeSlots(ArrayList<TimeSlotGeneric> value) { this.TimeSlots = value; return this; }
    }

    @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; }
    }

    @DataContract
    public static class TimeSlotGeneric
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public Date DateTime = null;

        @DataMember
        public Integer SlotsOpen = null;

        @DataMember
        public String Location = null;

        @DataMember
        public String Type = null;
        
        public Long getId() { return Id; }
        public TimeSlotGeneric setId(Long value) { this.Id = value; return this; }
        public Date getDateTime() { return DateTime; }
        public TimeSlotGeneric setDateTime(Date value) { this.DateTime = value; return this; }
        public Integer getSlotsOpen() { return SlotsOpen; }
        public TimeSlotGeneric setSlotsOpen(Integer value) { this.SlotsOpen = value; return this; }
        public String getLocation() { return Location; }
        public TimeSlotGeneric setLocation(String value) { this.Location = value; return this; }
        public String getType() { return Type; }
        public TimeSlotGeneric setType(String value) { this.Type = value; return this; }
    }

}

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