AIM Web Services

<back to all web services

GetSchedulingCalendarRequest

GetSchedulingCalendar
Requires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.

The following routes are available for this service:
GET/api/GetSchedulingCalendar
GET/api/GetSchedulingCalender
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * GetSchedulingCalendarRequires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.
    */
    @DataContract
    public static class GetSchedulingCalendarRequest extends BaseRequest
    {
        /**
        * The type of lessons to get a schedule for.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="The type of lessons to get a schedule for.", Format="int64", IsRequired=true, Name="TypeId", ParameterType="query")
        public Long TypeId = null;

        /**
        * If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used.
        */
        @DataMember
        @ApiMember(DataType="string", Description="If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used.", Format="date", Name="DateFrom", ParameterType="query")
        public String DateFrom = null;

        /**
        * If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used.
        */
        @DataMember
        @ApiMember(DataType="string", Description="If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used.", Format="date", Name="DateTo", ParameterType="query")
        public String DateTo = null;

        /**
        * If sent, only lessons taught by the sent instructor will be returned.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="If sent, only lessons taught by the sent instructor will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
        public Integer InstructorId = null;

        /**
        * If sent, lessons taught at the sent location will be returned.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="If sent, lessons taught at the sent location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
        public Long LocationId = null;
        
        public Long getTypeId() { return TypeId; }
        public GetSchedulingCalendarRequest setTypeId(Long value) { this.TypeId = value; return this; }
        public String getDateFrom() { return DateFrom; }
        public GetSchedulingCalendarRequest setDateFrom(String value) { this.DateFrom = value; return this; }
        public String getDateTo() { return DateTo; }
        public GetSchedulingCalendarRequest setDateTo(String value) { this.DateTo = value; return this; }
        public Integer getInstructorId() { return InstructorId; }
        public GetSchedulingCalendarRequest setInstructorId(Integer value) { this.InstructorId = value; return this; }
        public Long getLocationId() { return LocationId; }
        public GetSchedulingCalendarRequest setLocationId(Long value) { this.LocationId = 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 GetSchedulingCalendarResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<AvailabilityInfo> Availabilities = null;

        @DataMember
        public ArrayList<GroupClassInfo> GroupClasses = null;

        @DataMember
        public Integer TimeIncrement = null;

        @DataMember
        public ArrayList<TimeIncrementByInstructor> TimeIncrementsByInstructor = null;
        
        public ArrayList<AvailabilityInfo> getAvailabilities() { return Availabilities; }
        public GetSchedulingCalendarResponse setAvailabilities(ArrayList<AvailabilityInfo> value) { this.Availabilities = value; return this; }
        public ArrayList<GroupClassInfo> getGroupClasses() { return GroupClasses; }
        public GetSchedulingCalendarResponse setGroupClasses(ArrayList<GroupClassInfo> value) { this.GroupClasses = value; return this; }
        public Integer getTimeIncrement() { return TimeIncrement; }
        public GetSchedulingCalendarResponse setTimeIncrement(Integer value) { this.TimeIncrement = value; return this; }
        public ArrayList<TimeIncrementByInstructor> getTimeIncrementsByInstructor() { return TimeIncrementsByInstructor; }
        public GetSchedulingCalendarResponse setTimeIncrementsByInstructor(ArrayList<TimeIncrementByInstructor> value) { this.TimeIncrementsByInstructor = 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 AvailabilityInfo
    {
        @DataMember
        public Date StartTime = null;

        @DataMember
        public String StartTimeString = null;

        @DataMember
        public Integer Length = null;

        @DataMember
        public Integer InstructorId = null;

        @DataMember
        public Long LocationId = null;
        
        public Date getStartTime() { return StartTime; }
        public AvailabilityInfo setStartTime(Date value) { this.StartTime = value; return this; }
        public String getStartTimeString() { return StartTimeString; }
        public AvailabilityInfo setStartTimeString(String value) { this.StartTimeString = value; return this; }
        public Integer getLength() { return Length; }
        public AvailabilityInfo setLength(Integer value) { this.Length = value; return this; }
        public Integer getInstructorId() { return InstructorId; }
        public AvailabilityInfo setInstructorId(Integer value) { this.InstructorId = value; return this; }
        public Long getLocationId() { return LocationId; }
        public AvailabilityInfo setLocationId(Long value) { this.LocationId = value; return this; }
    }

    @DataContract
    public static class GroupClassInfo
    {
        @DataMember
        public ArrayList<DayTimeInfoObj> DayTimeInfo = null;

        @DataMember
        public Date StartDate = null;

        @DataMember
        public Date EndDate = null;

        @DataMember
        public UUID Guid = null;

        @DataMember
        public Integer Length = null;

        @DataMember
        public Integer InstructorId = null;

        @DataMember
        public Long LocationId = null;

        @DataMember
        public String ClassName = null;

        @DataMember
        public String ClassDesc = null;

        @DataMember
        public String ClassSummary = null;

        @DataMember
        public Integer MaxClassMembers = null;

        @DataMember
        public Integer CurrentClassMembers = null;

        @DataMember
        public String Notes = null;
        
        public ArrayList<DayTimeInfoObj> getDayTimeInfo() { return DayTimeInfo; }
        public GroupClassInfo setDayTimeInfo(ArrayList<DayTimeInfoObj> value) { this.DayTimeInfo = value; return this; }
        public Date getStartDate() { return StartDate; }
        public GroupClassInfo setStartDate(Date value) { this.StartDate = value; return this; }
        public Date getEndDate() { return EndDate; }
        public GroupClassInfo setEndDate(Date value) { this.EndDate = value; return this; }
        public UUID getGuid() { return Guid; }
        public GroupClassInfo setGuid(UUID value) { this.Guid = value; return this; }
        public Integer getLength() { return Length; }
        public GroupClassInfo setLength(Integer value) { this.Length = value; return this; }
        public Integer getInstructorId() { return InstructorId; }
        public GroupClassInfo setInstructorId(Integer value) { this.InstructorId = value; return this; }
        public Long getLocationId() { return LocationId; }
        public GroupClassInfo setLocationId(Long value) { this.LocationId = value; return this; }
        public String getClassName() { return ClassName; }
        public GroupClassInfo setClassName(String value) { this.ClassName = value; return this; }
        public String getClassDesc() { return ClassDesc; }
        public GroupClassInfo setClassDesc(String value) { this.ClassDesc = value; return this; }
        public String getClassSummary() { return ClassSummary; }
        public GroupClassInfo setClassSummary(String value) { this.ClassSummary = value; return this; }
        public Integer getMaxClassMembers() { return MaxClassMembers; }
        public GroupClassInfo setMaxClassMembers(Integer value) { this.MaxClassMembers = value; return this; }
        public Integer getCurrentClassMembers() { return CurrentClassMembers; }
        public GroupClassInfo setCurrentClassMembers(Integer value) { this.CurrentClassMembers = value; return this; }
        public String getNotes() { return Notes; }
        public GroupClassInfo setNotes(String value) { this.Notes = value; return this; }
    }

    @DataContract
    public static class DayTimeInfoObj
    {
        @DataMember
        public Integer WeekDayInt = null;

        @DataMember
        public String WeekDay = null;

        @DataMember
        public Date StartTime = null;

        @DataMember
        public String StartTimeString = null;
        
        public Integer getWeekDayInt() { return WeekDayInt; }
        public DayTimeInfoObj setWeekDayInt(Integer value) { this.WeekDayInt = value; return this; }
        public String getWeekDay() { return WeekDay; }
        public DayTimeInfoObj setWeekDay(String value) { this.WeekDay = value; return this; }
        public Date getStartTime() { return StartTime; }
        public DayTimeInfoObj setStartTime(Date value) { this.StartTime = value; return this; }
        public String getStartTimeString() { return StartTimeString; }
        public DayTimeInfoObj setStartTimeString(String value) { this.StartTimeString = value; return this; }
    }

    @DataContract
    public static class TimeIncrementByInstructor
    {
        @DataMember
        public Integer InstructorId = null;

        @DataMember
        public Integer TimeIncrement = null;
        
        public Integer getInstructorId() { return InstructorId; }
        public TimeIncrementByInstructor setInstructorId(Integer value) { this.InstructorId = value; return this; }
        public Integer getTimeIncrement() { return TimeIncrement; }
        public TimeIncrementByInstructor setTimeIncrement(Integer value) { this.TimeIncrement = value; return this; }
    }

}

Java GetSchedulingCalendarRequest DTOs

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.

GET /api/GetSchedulingCalendar HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Availabilities":[{"StartTimeString":"1/1/0001 12:00:00 AM","Length":0,"InstructorId":0,"LocationId":0}],"GroupClasses":[{"DayTimeInfo":[{"WeekDayInt":0,"WeekDay":"String","StartTimeString":"1/1/0001 12:00:00 AM"}],"Guid":"00000000000000000000000000000000","Length":0,"InstructorId":0,"LocationId":0,"ClassName":"String","ClassDesc":"String","ClassSummary":"String","MaxClassMembers":0,"CurrentClassMembers":0,"Notes":"String"}],"TimeIncrement":0,"TimeIncrementsByInstructor":[{"InstructorId":0,"TimeIncrement":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}