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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class 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")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    ///<summary>
    ///GetSchedulingInstructorsRequires active-e Lesson Scheduling Service
    ///</summary>
    [DataContract]
    public partial class GetSchedulingInstructorsRequest
        : 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")]
        public virtual int? InstructorId { 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")]
        public virtual long? GroupingId { 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")]
        public virtual long? TypeId { 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")]
        public virtual long? LocationId { 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")]
        public virtual bool IncludeAvailabilityInfo { get; set; }
    }

    [DataContract]
    public partial class GetSchedulingInstructorsResponse
        : BaseResponse
    {
        public GetSchedulingInstructorsResponse()
        {
            Instructors = new List<InstructorInfo>{};
        }

        [DataMember]
        public virtual List<InstructorInfo> Instructors { get; set; }
        [DataContract]
        public partial class InstructorInfo
        {
            [DataMember]
            public virtual int Id { get; set; }

            [DataMember]
            public virtual string Name { get; set; }

            [DataMember]
            public virtual string Email { get; set; }

            [DataMember]
            public virtual string Topic { get; set; }

            [DataMember]
            public virtual InstructorAvailabilityInfo AvailabilityInfo { get; set; }
            public partial class InstructorAvailabilityInfo
            {
                [DataMember]
                public virtual bool Sunday { get; set; }

                [DataMember]
                public virtual bool Monday { get; set; }

                [DataMember]
                public virtual bool Tuesday { get; set; }

                [DataMember]
                public virtual bool Wednesday { get; set; }

                [DataMember]
                public virtual bool Thursday { get; set; }

                [DataMember]
                public virtual bool Friday { get; set; }

                [DataMember]
                public virtual bool Saturday { get; set; }
            }

        }

    }

}

C# 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"}}