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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest:
    # @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    api_key: Optional[str] = None
    """
    This is your AIM API Key provided by Tri-Tech
    """


    # @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    o_auth_token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
    # @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    token: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    device_id: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    app_id: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
    # @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    status_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    login: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    error_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    error_display_text: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    error_message: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    domain_name: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    ip_address: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
    # @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    status: Optional[BaseResponseResult] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentInfoGeneric:
    student_name: Optional[str] = None
    customer_name: Optional[str] = None
    customer_number: Optional[str] = None
    customer_email: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StudentInfoScheduleGeneric(StudentInfoGeneric):
    class_member_id: int = 0
    marked_present: bool = False
    marked_absent: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleGeneric:
    is_availability: bool = False
    location: Optional[str] = None
    start_time: datetime.datetime = datetime.datetime(1, 1, 1)
    end_time: datetime.datetime = datetime.datetime(1, 1, 1)
    desc: Optional[str] = None
    appt_desc: Optional[str] = None
    color: Optional[str] = None
    area: Optional[str] = None
    virtual: bool = False
    students: Optional[List[StudentInfoScheduleGeneric]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InstructorTimeInfo:
    start_hour: int = 0
    start_minute: int = 0
    end_hour: int = 0
    end_minute: int = 0
    increment: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InstructorAvailabilityInfo:
    sunday: bool = False
    monday: bool = False
    tuesday: bool = False
    wednesday: bool = False
    thursday: bool = False
    friday: bool = False
    saturday: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class InstructorInfo:
    id: int = 0
    name: Optional[str] = None
    email: Optional[str] = None
    topic: Optional[str] = None
    availability_info: Optional[InstructorAvailabilityInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleByInstructor:
    instructor_info: Optional[InstructorInfo] = None
    instructor_schedule: Optional[List[ScheduleGeneric]] = None
    instructor_time_info: Optional[InstructorTimeInfo] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetInstructorScheduleResponse(BaseResponse):
    instructor_schedule: Optional[List[ScheduleGeneric]] = None
    instructor_time_info: Optional[InstructorTimeInfo] = None
    schedule_by_instructor: Optional[List[ScheduleByInstructor]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetInstructorScheduleRequest(BaseSecureRequest):
    """
    GetInstructorScheduleRequires active-e Lesson Scheduling Service
    """

    instructor_id: Optional[int] = None
    date_from: Optional[datetime.datetime] = None
    date_to: Optional[datetime.datetime] = None
    include_availability: Optional[bool] = None

Python GetInstructorScheduleRequest 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.

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

<GetInstructorScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <DateFrom>0001-01-01T00:00:00</DateFrom>
  <DateTo>0001-01-01T00:00:00</DateTo>
  <IncludeAvailability>false</IncludeAvailability>
  <InstructorId>0</InstructorId>
</GetInstructorScheduleRequest>

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

<GetInstructorScheduleResponse 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>
  <InstructorSchedule xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScheduleGeneric i:nil="true" />
  </InstructorSchedule>
  <InstructorTimeInfo i:nil="true" />
  <ScheduleByInstructor>
    <ScheduleByInstructor>
      <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>
      </InstructorInfo>
      <InstructorSchedule xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:ScheduleGeneric i:nil="true" />
      </InstructorSchedule>
      <InstructorTimeInfo i:nil="true" />
    </ScheduleByInstructor>
  </ScheduleByInstructor>
</GetInstructorScheduleResponse>