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
namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type StudentInfoGeneric() = 
        [<DataMember>]
        member val StudentName:String = null with get,set

        [<DataMember>]
        member val CustomerName:String = null with get,set

        [<DataMember>]
        member val CustomerNumber:String = null with get,set

        [<DataMember>]
        member val CustomerEmail:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type StudentInfoScheduleGeneric() = 
        inherit StudentInfoGeneric()
        [<DataMember>]
        member val ClassMemberId:Int64 = new Int64() with get,set

        [<DataMember>]
        member val MarkedPresent:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val MarkedAbsent:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ScheduleGeneric() = 
        [<DataMember>]
        member val IsAvailability:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Location:String = null with get,set

        [<DataMember>]
        member val StartTime:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val EndTime:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val Desc:String = null with get,set

        [<DataMember>]
        member val ApptDesc:String = null with get,set

        [<DataMember>]
        member val Color:String = null with get,set

        [<DataMember>]
        member val Area:String = null with get,set

        [<DataMember>]
        member val Virtual:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Students:ResizeArray<StudentInfoScheduleGeneric> = new ResizeArray<StudentInfoScheduleGeneric>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InstructorTimeInfo() = 
        [<DataMember>]
        member val StartHour:Int32 = new Int32() with get,set

        [<DataMember>]
        member val StartMinute:Int32 = new Int32() with get,set

        [<DataMember>]
        member val EndHour:Int32 = new Int32() with get,set

        [<DataMember>]
        member val EndMinute:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Increment:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type InstructorAvailabilityInfo() = 
        [<DataMember>]
        member val Sunday:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Monday:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Tuesday:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Wednesday:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Thursday:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Friday:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Saturday:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type InstructorInfo() = 
        [<DataMember>]
        member val Id:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val Email:String = null with get,set

        [<DataMember>]
        member val Topic:String = null with get,set

        [<DataMember>]
        member val AvailabilityInfo:InstructorAvailabilityInfo = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ScheduleByInstructor() = 
        [<DataMember>]
        member val InstructorInfo:InstructorInfo = null with get,set

        [<DataMember>]
        member val InstructorSchedule:ResizeArray<ScheduleGeneric> = new ResizeArray<ScheduleGeneric>() with get,set

        [<DataMember>]
        member val InstructorTimeInfo:InstructorTimeInfo = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetInstructorScheduleResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val InstructorSchedule:ResizeArray<ScheduleGeneric> = new ResizeArray<ScheduleGeneric>() with get,set

        [<DataMember>]
        member val InstructorTimeInfo:InstructorTimeInfo = null with get,set

        [<DataMember>]
        member val ScheduleByInstructor:ResizeArray<ScheduleByInstructor> = new ResizeArray<ScheduleByInstructor>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///GetInstructorScheduleRequires active-e Lesson Scheduling Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type GetInstructorScheduleRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val InstructorId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val DateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val DateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val IncludeAvailability:Nullable<Boolean> = new Nullable<Boolean>() with get,set

F# GetInstructorScheduleRequest DTOs

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

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<GetInstructorScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <IncludeAvailability>false</IncludeAvailability>
  <InstructorId>0</InstructorId>
</GetInstructorScheduleRequest>

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

<GetInstructorScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <InstructorSchedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScheduleGeneric i:nil="true" />
  </InstructorSchedule>
  <InstructorTimeInfo i:nil="true" />
  <ScheduleByInstructor>
    <ScheduleByInstructor>
      <InstructorInfo>
        <AvailabilityInfo>
          <Friday>false</Friday>
          <Monday>false</Monday>
          <Saturday>false</Saturday>
          <Sunday>false</Sunday>
          <Thursday>false</Thursday>
          <Tuesday>false</Tuesday>
          <Wednesday>false</Wednesday>
        </AvailabilityInfo>
        <Email>String</Email>
        <Id>0</Id>
        <Name>String</Name>
        <Topic>String</Topic>
      </InstructorInfo>
      <InstructorSchedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:ScheduleGeneric i:nil="true" />
      </InstructorSchedule>
      <InstructorTimeInfo i:nil="true" />
    </ScheduleByInstructor>
  </ScheduleByInstructor>
</GetInstructorScheduleResponse>