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

namespace AIM
{
    [DataContract]
    public partial class ScheduleGeneric
    {
        public ScheduleGeneric()
        {
            Students = new List<StudentInfoScheduleGeneric>{};
        }

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

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

        [DataMember]
        public virtual DateTime StartTime { get; set; }

        [DataMember]
        public virtual DateTime EndTime { get; set; }

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

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

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

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

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

        [DataMember]
        public virtual List<StudentInfoScheduleGeneric> Students { get; set; }
    }

    [DataContract]
    public partial class StudentInfoGeneric
    {
        [DataMember]
        public virtual string StudentName { get; set; }

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

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

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

    [DataContract]
    public partial class StudentInfoScheduleGeneric
        : StudentInfoGeneric
    {
        [DataMember]
        public virtual long ClassMemberId { get; set; }

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

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

}

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; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

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

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

    ///<summary>
    ///GetInstructorScheduleRequires active-e Lesson Scheduling Service
    ///</summary>
    [DataContract]
    public partial class GetInstructorScheduleRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual int? InstructorId { get; set; }

        [DataMember]
        public virtual DateTime? DateFrom { get; set; }

        [DataMember]
        public virtual DateTime? DateTo { get; set; }

        [DataMember]
        public virtual bool? IncludeAvailability { get; set; }
    }

    [DataContract]
    public partial class GetInstructorScheduleResponse
        : BaseResponse
    {
        public GetInstructorScheduleResponse()
        {
            InstructorSchedule = new List<ScheduleGeneric>{};
            ScheduleByInstructor = new List<ScheduleByInstructor>{};
        }

        [DataMember]
        public virtual List<ScheduleGeneric> InstructorSchedule { get; set; }

        [DataMember]
        public virtual InstructorTimeInfo InstructorTimeInfo { get; set; }

        [DataMember]
        public virtual List<ScheduleByInstructor> ScheduleByInstructor { get; set; }
    }

    [DataContract]
    public partial class InstructorTimeInfo
    {
        [DataMember]
        public virtual int StartHour { get; set; }

        [DataMember]
        public virtual int StartMinute { get; set; }

        [DataMember]
        public virtual int EndHour { get; set; }

        [DataMember]
        public virtual int EndMinute { get; set; }

        [DataMember]
        public virtual int Increment { get; set; }
    }

    [DataContract]
    public partial class ScheduleByInstructor
    {
        public ScheduleByInstructor()
        {
            InstructorSchedule = new List<ScheduleGeneric>{};
        }

        [DataMember]
        public virtual InstructorInfo InstructorInfo { get; set; }

        [DataMember]
        public virtual List<ScheduleGeneric> InstructorSchedule { get; set; }

        [DataMember]
        public virtual InstructorTimeInfo InstructorTimeInfo { get; set; }
    }

}

C# GetInstructorScheduleRequest 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.

POST /api/GetInstructorSchedule HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

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