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 java.io.InputStream
import net.servicestack.client.*


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

    @DataMember
    open var DateFrom:Date? = null

    @DataMember
    open var DateTo:Date? = null

    @DataMember
    open var IncludeAvailability:Boolean? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    open var Token: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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    open var DeviceId:String? = null

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

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

    @DataMember
    open var InstructorTimeInfo:InstructorTimeInfo? = null

    @DataMember
    open var ScheduleByInstructor:ArrayList<ScheduleByInstructor>? = null
}

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

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

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

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

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

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

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

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

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

    @DataMember
    open var Location:String? = null

    @DataMember
    open var StartTime:Date? = null

    @DataMember
    open var EndTime:Date? = null

    @DataMember
    open var Desc:String? = null

    @DataMember
    open var ApptDesc:String? = null

    @DataMember
    open var Color:String? = null

    @DataMember
    open var Area:String? = null

    @DataMember
    open var Virtual:Boolean? = null

    @DataMember
    open var Students:ArrayList<StudentInfoScheduleGeneric>? = null
}

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

    @DataMember
    open var MarkedPresent:Boolean? = null

    @DataMember
    open var MarkedAbsent:Boolean? = null
}

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

    @DataMember
    open var CustomerName:String? = null

    @DataMember
    open var CustomerNumber:String? = null

    @DataMember
    open var CustomerEmail:String? = null
}

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

    @DataMember
    open var StartMinute:Int? = null

    @DataMember
    open var EndHour:Int? = null

    @DataMember
    open var EndMinute:Int? = null

    @DataMember
    open var Increment:Int? = null
}

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

    @DataMember
    open var InstructorSchedule:ArrayList<ScheduleGeneric>? = null

    @DataMember
    open var InstructorTimeInfo:InstructorTimeInfo? = null
}

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

    @DataMember
    open var Name:String? = null

    @DataMember
    open var Email:String? = null

    @DataMember
    open var Topic:String? = null

    @DataMember
    open var AvailabilityInfo:InstructorAvailabilityInfo? = null
}

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

    @DataMember
    open var Monday:Boolean? = null

    @DataMember
    open var Tuesday:Boolean? = null

    @DataMember
    open var Wednesday:Boolean? = null

    @DataMember
    open var Thursday:Boolean? = null

    @DataMember
    open var Friday:Boolean? = null

    @DataMember
    open var Saturday:Boolean? = null
}

Kotlin GetInstructorScheduleRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}