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.*


/**
* GetInstructorScheduleRequires active-e Lesson Scheduling Service
*/
@DataContract
open class GetInstructorScheduleRequest : BaseSecureRequest()
{
    @DataMember
    var InstructorId:Int? = null

    @DataMember
    var DateFrom:Date? = null

    @DataMember
    var DateTo:Date? = null

    @DataMember
    var IncludeAvailability:Boolean? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open 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")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class GetInstructorScheduleResponse : BaseResponse()
{
    @DataMember
    var InstructorSchedule:ArrayList<ScheduleGeneric> = ArrayList<ScheduleGeneric>()

    @DataMember
    var InstructorTimeInfo:InstructorTimeInfo? = null

    @DataMember
    var ScheduleByInstructor:ArrayList<ScheduleByInstructor> = ArrayList<ScheduleByInstructor>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class ScheduleGeneric
{
    @DataMember
    var IsAvailability:Boolean? = null

    @DataMember
    var Location:String? = null

    @DataMember
    var StartTime:Date? = null

    @DataMember
    var EndTime:Date? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ApptDesc:String? = null

    @DataMember
    var Color:String? = null

    @DataMember
    var Area:String? = null

    @DataMember
    var Virtual:Boolean? = null

    @DataMember
    var Students:ArrayList<StudentInfoScheduleGeneric> = ArrayList<StudentInfoScheduleGeneric>()
}

@DataContract
open class StudentInfoScheduleGeneric : StudentInfoGeneric()
{
    @DataMember
    var ClassMemberId:Long? = null

    @DataMember
    var MarkedPresent:Boolean? = null

    @DataMember
    var MarkedAbsent:Boolean? = null
}

@DataContract
open class StudentInfoGeneric
{
    @DataMember
    var StudentName:String? = null

    @DataMember
    var CustomerName:String? = null

    @DataMember
    var CustomerNumber:String? = null

    @DataMember
    var CustomerEmail:String? = null
}

@DataContract
open class InstructorTimeInfo
{
    @DataMember
    var StartHour:Int? = null

    @DataMember
    var StartMinute:Int? = null

    @DataMember
    var EndHour:Int? = null

    @DataMember
    var EndMinute:Int? = null

    @DataMember
    var Increment:Int? = null
}

@DataContract
open class ScheduleByInstructor
{
    @DataMember
    var InstructorInfo:InstructorInfo? = null

    @DataMember
    var InstructorSchedule:ArrayList<ScheduleGeneric> = ArrayList<ScheduleGeneric>()

    @DataMember
    var InstructorTimeInfo:InstructorTimeInfo? = null
}

@DataContract
open class InstructorInfo
{
    @DataMember
    var Id:Int? = null

    @DataMember
    var Name:String? = null

    @DataMember
    var Email:String? = null

    @DataMember
    var Topic:String? = null

    @DataMember
    var AvailabilityInfo:InstructorAvailabilityInfo? = null
}

open class InstructorAvailabilityInfo
{
    @DataMember
    var Sunday:Boolean? = null

    @DataMember
    var Monday:Boolean? = null

    @DataMember
    var Tuesday:Boolean? = null

    @DataMember
    var Wednesday:Boolean? = null

    @DataMember
    var Thursday:Boolean? = null

    @DataMember
    var Friday:Boolean? = null

    @DataMember
    var Saturday:Boolean? = null
}

Kotlin 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"}}