AIM Web Services

<back to all web services

GetInstructorScheduleRequest

GetInstructorSchedule
Requires active-e Lesson Scheduling Service

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

public class dtos
{

    /**
    * GetInstructorScheduleRequires active-e Lesson Scheduling Service
    */
    @DataContract
    public static class GetInstructorScheduleRequest extends BaseSecureRequest
    {
        @DataMember
        public Integer InstructorId = null;

        @DataMember
        public Date DateFrom = null;

        @DataMember
        public Date DateTo = null;

        @DataMember
        public Boolean IncludeAvailability = null;
        
        public Integer getInstructorId() { return InstructorId; }
        public GetInstructorScheduleRequest setInstructorId(Integer value) { this.InstructorId = value; return this; }
        public Date getDateFrom() { return DateFrom; }
        public GetInstructorScheduleRequest setDateFrom(Date value) { this.DateFrom = value; return this; }
        public Date getDateTo() { return DateTo; }
        public GetInstructorScheduleRequest setDateTo(Date value) { this.DateTo = value; return this; }
        public Boolean isIncludeAvailability() { return IncludeAvailability; }
        public GetInstructorScheduleRequest setIncludeAvailability(Boolean value) { this.IncludeAvailability = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = 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 GetInstructorScheduleResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<ScheduleGeneric> InstructorSchedule = null;

        @DataMember
        public InstructorTimeInfo InstructorTimeInfo = null;

        @DataMember
        public ArrayList<ScheduleByInstructor> ScheduleByInstructor = null;
        
        public ArrayList<ScheduleGeneric> getInstructorSchedule() { return InstructorSchedule; }
        public GetInstructorScheduleResponse setInstructorSchedule(ArrayList<ScheduleGeneric> value) { this.InstructorSchedule = value; return this; }
        public InstructorTimeInfo getInstructorTimeInfo() { return InstructorTimeInfo; }
        public GetInstructorScheduleResponse setInstructorTimeInfo(InstructorTimeInfo value) { this.InstructorTimeInfo = value; return this; }
        public ArrayList<ScheduleByInstructor> getScheduleByInstructor() { return ScheduleByInstructor; }
        public GetInstructorScheduleResponse setScheduleByInstructor(ArrayList<ScheduleByInstructor> value) { this.ScheduleByInstructor = 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 ScheduleGeneric
    {
        @DataMember
        public Boolean IsAvailability = null;

        @DataMember
        public String Location = null;

        @DataMember
        public Date StartTime = null;

        @DataMember
        public Date EndTime = null;

        @DataMember
        public String Desc = null;

        @DataMember
        public String ApptDesc = null;

        @DataMember
        public String Color = null;

        @DataMember
        public String Area = null;

        @DataMember
        public Boolean Virtual = null;

        @DataMember
        public ArrayList<StudentInfoScheduleGeneric> Students = null;
        
        public Boolean getIsAvailability() { return IsAvailability; }
        public ScheduleGeneric setIsAvailability(Boolean value) { this.IsAvailability = value; return this; }
        public String getLocation() { return Location; }
        public ScheduleGeneric setLocation(String value) { this.Location = value; return this; }
        public Date getStartTime() { return StartTime; }
        public ScheduleGeneric setStartTime(Date value) { this.StartTime = value; return this; }
        public Date getEndTime() { return EndTime; }
        public ScheduleGeneric setEndTime(Date value) { this.EndTime = value; return this; }
        public String getDesc() { return Desc; }
        public ScheduleGeneric setDesc(String value) { this.Desc = value; return this; }
        public String getApptDesc() { return ApptDesc; }
        public ScheduleGeneric setApptDesc(String value) { this.ApptDesc = value; return this; }
        public String getColor() { return Color; }
        public ScheduleGeneric setColor(String value) { this.Color = value; return this; }
        public String getArea() { return Area; }
        public ScheduleGeneric setArea(String value) { this.Area = value; return this; }
        public Boolean isVirtual() { return Virtual; }
        public ScheduleGeneric setVirtual(Boolean value) { this.Virtual = value; return this; }
        public ArrayList<StudentInfoScheduleGeneric> getStudents() { return Students; }
        public ScheduleGeneric setStudents(ArrayList<StudentInfoScheduleGeneric> value) { this.Students = value; return this; }
    }

    @DataContract
    public static class StudentInfoScheduleGeneric extends StudentInfoGeneric
    {
        @DataMember
        public Long ClassMemberId = null;

        @DataMember
        public Boolean MarkedPresent = null;

        @DataMember
        public Boolean MarkedAbsent = null;
        
        public Long getClassMemberId() { return ClassMemberId; }
        public StudentInfoScheduleGeneric setClassMemberId(Long value) { this.ClassMemberId = value; return this; }
        public Boolean isMarkedPresent() { return MarkedPresent; }
        public StudentInfoScheduleGeneric setMarkedPresent(Boolean value) { this.MarkedPresent = value; return this; }
        public Boolean isMarkedAbsent() { return MarkedAbsent; }
        public StudentInfoScheduleGeneric setMarkedAbsent(Boolean value) { this.MarkedAbsent = value; return this; }
    }

    @DataContract
    public static class StudentInfoGeneric
    {
        @DataMember
        public String StudentName = null;

        @DataMember
        public String CustomerName = null;

        @DataMember
        public String CustomerNumber = null;

        @DataMember
        public String CustomerEmail = null;
        
        public String getStudentName() { return StudentName; }
        public StudentInfoGeneric setStudentName(String value) { this.StudentName = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public StudentInfoGeneric setCustomerName(String value) { this.CustomerName = value; return this; }
        public String getCustomerNumber() { return CustomerNumber; }
        public StudentInfoGeneric setCustomerNumber(String value) { this.CustomerNumber = value; return this; }
        public String getCustomerEmail() { return CustomerEmail; }
        public StudentInfoGeneric setCustomerEmail(String value) { this.CustomerEmail = value; return this; }
    }

    @DataContract
    public static class InstructorTimeInfo
    {
        @DataMember
        public Integer StartHour = null;

        @DataMember
        public Integer StartMinute = null;

        @DataMember
        public Integer EndHour = null;

        @DataMember
        public Integer EndMinute = null;

        @DataMember
        public Integer Increment = null;
        
        public Integer getStartHour() { return StartHour; }
        public InstructorTimeInfo setStartHour(Integer value) { this.StartHour = value; return this; }
        public Integer getStartMinute() { return StartMinute; }
        public InstructorTimeInfo setStartMinute(Integer value) { this.StartMinute = value; return this; }
        public Integer getEndHour() { return EndHour; }
        public InstructorTimeInfo setEndHour(Integer value) { this.EndHour = value; return this; }
        public Integer getEndMinute() { return EndMinute; }
        public InstructorTimeInfo setEndMinute(Integer value) { this.EndMinute = value; return this; }
        public Integer getIncrement() { return Increment; }
        public InstructorTimeInfo setIncrement(Integer value) { this.Increment = value; return this; }
    }

    @DataContract
    public static class ScheduleByInstructor
    {
        @DataMember
        public InstructorInfo InstructorInfo = null;

        @DataMember
        public ArrayList<ScheduleGeneric> InstructorSchedule = null;

        @DataMember
        public InstructorTimeInfo InstructorTimeInfo = null;
        
        public InstructorInfo getInstructorInfo() { return InstructorInfo; }
        public ScheduleByInstructor setInstructorInfo(InstructorInfo value) { this.InstructorInfo = value; return this; }
        public ArrayList<ScheduleGeneric> getInstructorSchedule() { return InstructorSchedule; }
        public ScheduleByInstructor setInstructorSchedule(ArrayList<ScheduleGeneric> value) { this.InstructorSchedule = value; return this; }
        public InstructorTimeInfo getInstructorTimeInfo() { return InstructorTimeInfo; }
        public ScheduleByInstructor setInstructorTimeInfo(InstructorTimeInfo value) { this.InstructorTimeInfo = value; return this; }
    }

    @DataContract
    public static class InstructorInfo
    {
        @DataMember
        public Integer Id = null;

        @DataMember
        public String Name = null;

        @DataMember
        public String Email = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public InstructorAvailabilityInfo AvailabilityInfo = null;
        
        public Integer getId() { return Id; }
        public InstructorInfo setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public InstructorInfo setName(String value) { this.Name = value; return this; }
        public String getEmail() { return Email; }
        public InstructorInfo setEmail(String value) { this.Email = value; return this; }
        public String getTopic() { return Topic; }
        public InstructorInfo setTopic(String value) { this.Topic = value; return this; }
        public InstructorAvailabilityInfo getAvailabilityInfo() { return AvailabilityInfo; }
        public InstructorInfo setAvailabilityInfo(InstructorAvailabilityInfo value) { this.AvailabilityInfo = value; return this; }
    }

    public static class InstructorAvailabilityInfo
    {
        @DataMember
        public Boolean Sunday = null;

        @DataMember
        public Boolean Monday = null;

        @DataMember
        public Boolean Tuesday = null;

        @DataMember
        public Boolean Wednesday = null;

        @DataMember
        public Boolean Thursday = null;

        @DataMember
        public Boolean Friday = null;

        @DataMember
        public Boolean Saturday = null;
        
        public Boolean isSunday() { return Sunday; }
        public InstructorAvailabilityInfo setSunday(Boolean value) { this.Sunday = value; return this; }
        public Boolean isMonday() { return Monday; }
        public InstructorAvailabilityInfo setMonday(Boolean value) { this.Monday = value; return this; }
        public Boolean isTuesday() { return Tuesday; }
        public InstructorAvailabilityInfo setTuesday(Boolean value) { this.Tuesday = value; return this; }
        public Boolean isWednesday() { return Wednesday; }
        public InstructorAvailabilityInfo setWednesday(Boolean value) { this.Wednesday = value; return this; }
        public Boolean isThursday() { return Thursday; }
        public InstructorAvailabilityInfo setThursday(Boolean value) { this.Thursday = value; return this; }
        public Boolean isFriday() { return Friday; }
        public InstructorAvailabilityInfo setFriday(Boolean value) { this.Friday = value; return this; }
        public Boolean isSaturday() { return Saturday; }
        public InstructorAvailabilityInfo setSaturday(Boolean value) { this.Saturday = value; return this; }
    }

}

Java GetInstructorScheduleRequest 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.

POST /api/GetInstructorSchedule HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"InstructorId":0,"DateFrom":"0001-01-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","IncludeAvailability":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"InstructorSchedule":[{}],"ScheduleByInstructor":[{"InstructorInfo":{"Id":0,"Name":"String","Email":"String","Topic":"String","AvailabilityInfo":{"Sunday":false,"Monday":false,"Tuesday":false,"Wednesday":false,"Thursday":false,"Friday":false,"Saturday":false}},"InstructorSchedule":[{}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}