| GET | /api/GetSchedulingTypes |
|---|
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 TypeInfo:
id: int = 0
desc: Optional[str] = None
length: int = 0
topic: Optional[str] = None
recurrance_type: Optional[str] = None
membership_type: Optional[str] = None
rate: Decimal = decimal.Decimal(0)
grouping_id: Optional[int] = None
grouping_desc: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSchedulingTypesResponse(BaseResponse):
types: Optional[List[TypeInfo]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSchedulingTypesRequest(BaseRequest):
"""
GetSchedulingTypesRequires active-e Lesson Scheduling Service
"""
# @ApiMember(DataType="integer", Description="Type ID to look up. If sent, all other parameters will be ignored.", Format="int64", Name="TypeId", ParameterType="query")
type_id: Optional[int] = None
"""
Type ID to look up. If sent, all other parameters will be ignored.
"""
# @ApiMember(DataType="integer", Description="If sent, only types in the sent grouping will be returned.", Format="int64", Name="GroupingId", ParameterType="query")
grouping_id: Optional[int] = None
"""
If sent, only types in the sent grouping will be returned.
"""
# @ApiMember(DataType="integer", Description="If sent, only types taught by the sent instructor will be returned.", Format="int32", Name="InstructorId", ParameterType="query")
instructor_id: Optional[int] = None
"""
If sent, only types taught by the sent instructor will be returned.
"""
# @ApiMember(DataType="integer", Description="If sent, only types taught at the sent location will be returned.", Format="int64", Name="LocationId", ParameterType="query")
location_id: Optional[int] = None
"""
If sent, only types taught at the sent location will be returned.
"""
# @ApiMember(DataType="integer", Description="If sent, should be Private or Group. If Private, only Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned.", Format="int64", Name="MembershipType", ParameterType="query")
membership_type: Optional[str] = None
"""
If sent, should be Private or Group. If Private, only Private Lesson Types will be returned. If Group, only Group Lesson Types will be returned.
"""
Python GetSchedulingTypesRequest 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/GetSchedulingTypes HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSchedulingTypesResponse 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>
<Types>
<GetSchedulingTypesResponse.TypeInfo>
<Desc>String</Desc>
<GroupingDesc>String</GroupingDesc>
<GroupingId>0</GroupingId>
<Id>0</Id>
<Length>0</Length>
<MembershipType>String</MembershipType>
<Rate>0</Rate>
<RecurranceType>String</RecurranceType>
<Topic>String</Topic>
</GetSchedulingTypesResponse.TypeInfo>
</Types>
</GetSchedulingTypesResponse>