AIM Web Services

<back to all web services

GetSchedulingInstructorsRequest

GetSchedulingInstructors
Requires active-e Lesson Scheduling Service

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


/**
* GetSchedulingInstructorsRequires active-e Lesson Scheduling Service
*/
@DataContract
open class GetSchedulingInstructorsRequest : BaseRequest()
{
    /**
    * Instructor ID to lookup. If sent, other parameters will be ignored.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Instructor ID to lookup. If sent, other parameters will be ignored.", Format="int32", Name="InstructorId", ParameterType="query")
    var InstructorId:Int? = null

    /**
    * If sent, only instructors who teach lessons with the passed grouping will be returned.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="If sent, only instructors who teach lessons with the passed grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
    var GroupingId:Long? = null

    /**
    * If sent, only instructors who teach lessons with the passed type will be returned.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="If sent, only instructors who teach lessons with the passed type will be returned.", Format="int64", Name="TypeId", ParameterType="query")
    var TypeId:Long? = null

    /**
    * If sent, only instructors who have an availability record at the passed location will be returned.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="If sent, only instructors who have an availability record at the passed location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
    var LocationId:Long? = null

    /**
    * If true, basic Availability Info will be included in the response
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="If true, basic Availability Info will be included in the response", Name="IncludeAvailabilityInfo", ParameterType="query")
    var IncludeAvailabilityInfo:Boolean? = 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 GetSchedulingInstructorsResponse : BaseResponse()
{
    @DataMember
    var Instructors:ArrayList<InstructorInfo> = ArrayList<InstructorInfo>()
}

@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 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 GetSchedulingInstructorsRequest 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/GetSchedulingInstructors HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

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