| GET | /api/GetSchoolList |
|---|
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 C2BDeliveryInfo:
first_delivery: datetime.datetime = datetime.datetime(1, 1, 1)
delivery_time: datetime.datetime = datetime.datetime(1, 1, 1)
delivery_threshold: int = 0
sunday_delivery: bool = False
monday_delivery: bool = False
tuesday_delivery: bool = False
wednesday_delivery: bool = False
thursday_delivery: bool = False
friday_delivery: bool = False
saturday_delivery: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SchoolGeneric:
id: int = 0
school_name: Optional[str] = None
district: Optional[str] = None
address: Optional[str] = None
city: Optional[str] = None
state: Optional[str] = None
zip: Optional[str] = None
phone: Optional[str] = None
tax_auth: Optional[str] = None
delivery_info: Optional[C2BDeliveryInfo] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSchoolListResponse(BaseResponse):
schools: Optional[List[SchoolGeneric]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetSchoolListRequest(BaseSecureRequest):
"""
GetSchoolListRequires active-e Customer Service.
"""
# @ApiMember(DataType="integer", Description="District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned.", Format="int64", Name="DistrictId", ParameterType="query")
district_id: Optional[int] = None
"""
District ID. Skip this parameter to return all schools. -1 will return all schools that don't have a district assigned.
"""
Python GetSchoolListRequest 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/GetSchoolList HTTP/1.1 Host: active-ewebservice.biz Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<GetSchoolListResponse 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>
<Schools xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
<d2p1:SchoolGeneric>
<d2p1:Address>String</d2p1:Address>
<d2p1:City>String</d2p1:City>
<d2p1:DeliveryInfo>
<d2p1:DeliveryThreshold>0</d2p1:DeliveryThreshold>
<d2p1:DeliveryTime>0001-01-01T00:00:00</d2p1:DeliveryTime>
<d2p1:FirstDelivery>0001-01-01T00:00:00</d2p1:FirstDelivery>
<d2p1:FridayDelivery>false</d2p1:FridayDelivery>
<d2p1:MondayDelivery>false</d2p1:MondayDelivery>
<d2p1:SaturdayDelivery>false</d2p1:SaturdayDelivery>
<d2p1:SundayDelivery>false</d2p1:SundayDelivery>
<d2p1:ThursdayDelivery>false</d2p1:ThursdayDelivery>
<d2p1:TuesdayDelivery>false</d2p1:TuesdayDelivery>
<d2p1:WednesdayDelivery>false</d2p1:WednesdayDelivery>
</d2p1:DeliveryInfo>
<d2p1:District>String</d2p1:District>
<d2p1:Id>0</d2p1:Id>
<d2p1:Phone>String</d2p1:Phone>
<d2p1:SchoolName>String</d2p1:SchoolName>
<d2p1:State>String</d2p1:State>
<d2p1:TaxAuth>String</d2p1:TaxAuth>
<d2p1:Zip>String</d2p1:Zip>
</d2p1:SchoolGeneric>
</Schools>
</GetSchoolListResponse>