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

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

    [<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 GetSchedulingInstructorsResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Instructors:ResizeArray<InstructorInfo> = new ResizeArray<InstructorInfo>() 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

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

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

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

    ///<summary>
    ///GetSchedulingInstructorsRequires active-e Lesson Scheduling Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type GetSchedulingInstructorsRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///Instructor ID to lookup. If sent, other parameters will be ignored.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="integer", Description="Instructor ID to lookup. If sent, other parameters will be ignored.", Format="int32", Name="InstructorId", ParameterType="query")>]
        member val InstructorId:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<summary>
        ///If sent, only instructors who teach lessons with the passed grouping will be returned.
        ///</summary>
        [<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")>]
        member val GroupingId:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///If sent, only instructors who teach lessons with the passed type will be returned.
        ///</summary>
        [<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")>]
        member val TypeId:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///If sent, only instructors who have an availability record at the passed location will be returned.
        ///</summary>
        [<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")>]
        member val LocationId:Nullable<Int64> = new Nullable<Int64>() with get,set

        ///<summary>
        ///If true, basic Availability Info will be included in the response
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="boolean", Description="If true, basic Availability Info will be included in the response", Name="IncludeAvailabilityInfo", ParameterType="query")>]
        member val IncludeAvailabilityInfo:Boolean = new Boolean() with get,set

F# GetSchedulingInstructorsRequest 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.

GET /api/GetSchedulingInstructors HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetSchedulingInstructorsResponse 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>
  <Instructors>
    <GetSchedulingInstructorsResponse.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>
    </GetSchedulingInstructorsResponse.InstructorInfo>
  </Instructors>
</GetSchedulingInstructorsResponse>