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

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

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

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

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type GroupClassInfo() = 
        [<DataMember>]
        member val DayTimeInfo:ResizeArray<DayTimeInfoObj> = new ResizeArray<DayTimeInfoObj>() with get,set

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type GetSchedulingCalendarResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Availabilities:ResizeArray<AvailabilityInfo> = new ResizeArray<AvailabilityInfo>() with get,set

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

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

        [<DataMember>]
        member val TimeIncrementsByInstructor:ResizeArray<TimeIncrementByInstructor> = new ResizeArray<TimeIncrementByInstructor>() 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

    ///<summary>
    ///GetSchedulingCalendarRequires active-e Lesson Scheduling Service. This API call was accidentally named GetSchedulingCalender in the past.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type GetSchedulingCalendarRequest() = 
        inherit 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")>]
        member val TypeId:Int64 = new Int64() with 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")>]
        member val DateFrom:String = null with 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")>]
        member val DateTo:String = null with 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")>]
        member val InstructorId:Nullable<Int32> = new Nullable<Int32>() with 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")>]
        member val LocationId:Nullable<Int64> = new Nullable<Int64>() with get,set

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