AIM Web Services

<back to all web services

GetSchedulingCalendarRequest

GetSchedulingCalendar
Requires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.

The following routes are available for this service:
GET/api/GetSchedulingCalendar
GET/api/GetSchedulingCalender
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>
    ///GetSchedulingCalendarRequires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.
    ///</summary>
    [DataContract]
    public partial class GetSchedulingCalendarRequest
        : BaseRequest
    {
        ///<summary>
        ///The type of lessons to get a schedule for.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The type of lessons to get a schedule for.", Format="int64", IsRequired=true, Name="TypeId", ParameterType="query")]
        public virtual long TypeId { get; set; }

        ///<summary>
        ///If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="If sent, lessons from this date/time onward will be returned. Otherwise the current date/time is used.", Format="date", Name="DateFrom", ParameterType="query")]
        public virtual string DateFrom { get; set; }

        ///<summary>
        ///If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="If sent, lessons from before this date/time will be returned. Otherwise the DateFrom plus one week is used.", Format="date", Name="DateTo", ParameterType="query")]
        public virtual string DateTo { get; set; }

        ///<summary>
        ///If sent, only lessons taught by the sent instructor will be returned.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="If sent, only lessons taught by the sent instructor will be returned.", Format="int32", Name="InstructorId", ParameterType="query")]
        public virtual int? InstructorId { get; set; }

        ///<summary>
        ///If sent, lessons taught at the sent location will be returned.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="If sent, lessons taught at the sent location will be returned.", Format="int64", Name="LocationId", ParameterType="query")]
        public virtual long? LocationId { get; set; }
    }

    [DataContract]
    public partial class GetSchedulingCalendarResponse
        : BaseResponse
    {
        public GetSchedulingCalendarResponse()
        {
            Availabilities = new List<AvailabilityInfo>{};
            GroupClasses = new List<GroupClassInfo>{};
            TimeIncrementsByInstructor = new List<TimeIncrementByInstructor>{};
        }

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

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

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

        [DataMember]
        public virtual List<TimeIncrementByInstructor> TimeIncrementsByInstructor { get; set; }
        [DataContract]
        public partial class AvailabilityInfo
        {
            [DataMember]
            public virtual DateTime StartTime { get; set; }

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

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

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

            [DataMember]
            public virtual long LocationId { get; set; }
        }

        [DataContract]
        public partial class TimeIncrementByInstructor
        {
            [DataMember]
            public virtual int InstructorId { get; set; }

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

        [DataContract]
        public partial class GroupClassInfo
        {
            public GroupClassInfo()
            {
                DayTimeInfo = new List<DayTimeInfoObj>{};
            }

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

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

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

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

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

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

            [DataMember]
            public virtual long LocationId { get; set; }

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

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

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

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

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

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

        [DataContract]
        public partial class DayTimeInfoObj
        {
            [DataMember]
            public virtual int WeekDayInt { get; set; }

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

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

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

    }

}

C# GetSchedulingCalendarRequest 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/GetSchedulingCalendar HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetSchedulingCalendarResponse 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>
  <Availabilities>
    <GetSchedulingCalendarResponse.AvailabilityInfo>
      <InstructorId>0</InstructorId>
      <Length>0</Length>
      <LocationId>0</LocationId>
      <StartTime>0001-01-01T00:00:00</StartTime>
      <StartTimeString>1/1/0001 12:00:00 AM</StartTimeString>
    </GetSchedulingCalendarResponse.AvailabilityInfo>
  </Availabilities>
  <GroupClasses>
    <GetSchedulingCalendarResponse.GroupClassInfo>
      <ClassDesc>String</ClassDesc>
      <ClassName>String</ClassName>
      <ClassSummary>String</ClassSummary>
      <CurrentClassMembers>0</CurrentClassMembers>
      <DayTimeInfo>
        <GetSchedulingCalendarResponse.DayTimeInfoObj>
          <StartTime>0001-01-01T00:00:00</StartTime>
          <StartTimeString>1/1/0001 12:00:00 AM</StartTimeString>
          <WeekDay>String</WeekDay>
          <WeekDayInt>0</WeekDayInt>
        </GetSchedulingCalendarResponse.DayTimeInfoObj>
      </DayTimeInfo>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <Guid>00000000-0000-0000-0000-000000000000</Guid>
      <InstructorId>0</InstructorId>
      <Length>0</Length>
      <LocationId>0</LocationId>
      <MaxClassMembers>0</MaxClassMembers>
      <Notes>String</Notes>
      <StartDate>0001-01-01T00:00:00</StartDate>
    </GetSchedulingCalendarResponse.GroupClassInfo>
  </GroupClasses>
  <TimeIncrement>0</TimeIncrement>
  <TimeIncrementsByInstructor>
    <GetSchedulingCalendarResponse.TimeIncrementByInstructor>
      <InstructorId>0</InstructorId>
      <TimeIncrement>0</TimeIncrement>
    </GetSchedulingCalendarResponse.TimeIncrementByInstructor>
  </TimeIncrementsByInstructor>
</GetSchedulingCalendarResponse>