| GET | /api/GetSchedulingInstructors |
|---|
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 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 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 GetSchedulingInstructorsResponse(BaseResponse):
instructors: Optional[List[InstructorInfo]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSchedulingInstructorsRequest(BaseRequest):
"""
GetSchedulingInstructorsRequires active-e Lesson Scheduling Service
"""
# @ApiMember(DataType="integer", Description="Instructor ID to lookup. If sent, other parameters will be ignored.", Format="int32", Name="InstructorId", ParameterType="query")
instructor_id: Optional[int] = None
"""
Instructor ID to lookup. If sent, other parameters will be ignored.
"""
# @ApiMember(DataType="integer", Description="If sent, only instructors who teach lessons with the passed grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
grouping_id: Optional[int] = None
"""
If sent, only instructors who teach lessons with the passed grouping will be returned.
"""
# @ApiMember(DataType="integer", Description="If sent, only instructors who teach lessons with the passed type will be returned.", Format="int64", Name="TypeId", ParameterType="query")
type_id: Optional[int] = None
"""
If sent, only instructors who teach lessons with the passed type will be returned.
"""
# @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")
location_id: Optional[int] = None
"""
If sent, only instructors who have an availability record at the passed location will be returned.
"""
# @ApiMember(DataType="boolean", Description="If true, basic Availability Info will be included in the response", Name="IncludeAvailabilityInfo", ParameterType="query")
include_availability_info: bool = False
"""
If true, basic Availability Info will be included in the response
"""
Python GetSchedulingInstructorsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSchedulingInstructorsResponse 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>
<Instructors>
<GetSchedulingInstructorsResponse.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>
</GetSchedulingInstructorsResponse.InstructorInfo>
</Instructors>
</GetSchedulingInstructorsResponse>