| POST | /api/PostSchedulingPrivate |
|---|
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 PostSchedulingPrivateResponse(BaseResponse):
pass
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerInfo:
# @ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query")
web_id: Optional[int] = None
"""
The WebId of the customer. Optional.
"""
# @ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")
name: Optional[str] = None
"""
Name of the customer.
"""
# @ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")
addr1: Optional[str] = None
"""
Address line 1 of the customer
"""
# @ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")
addr2: Optional[str] = None
"""
Address line 2 of the customer
"""
# @ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")
city: Optional[str] = None
"""
City of the customer
"""
# @ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")
st: Optional[str] = None
"""
State/Province of the customer
"""
# @ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")
zip: Optional[str] = None
"""
Zip code of the customer
"""
# @ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")
country: Optional[str] = None
"""
Country of the customer
"""
# @ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")
phone: Optional[str] = None
"""
Phone number of the customer
"""
# @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
email: Optional[str] = None
"""
Email address of the customer. Required.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FormInput:
# @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
key: Optional[str] = None
"""
Field Name of the Input Field
"""
# @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
value: Optional[str] = None
"""
Value of the Input Field.
"""
# @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
encrypted: bool = False
"""
Whether or not the field is encryped with the C2B encryption key.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CcInfo:
# @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
token_str: Optional[str] = None
"""
Token returned from processor
"""
# @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
card_type: Optional[str] = None
"""
Card Type (VISA, MCARD, AMEX, DSCVR)
"""
# @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
last_four: Optional[str] = None
"""
Last four of the card
"""
# @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
expiration: Optional[str] = None
"""
Expiration Date of the Card. (MM/YY)
"""
# @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
reason_on_file: Optional[str] = None
"""
Reason the card is on file.
"""
# @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
token_pk: Optional[int] = None
"""
ID of the existing Token Record in AIM, if applicable
"""
# @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
primary: Optional[bool] = None
"""
Is this the customer's primary card? Defaults to false.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PostSchedulingPrivateRequest(BaseRequest):
"""
PostSchedulingPrivateRequires active-e Lesson Scheduling Service
"""
# @ApiMember(DataType="integer", Description="The type ID of the private appointment", Format="int64", IsRequired=true, Name="TypeId", ParameterType="query")
type_id: Optional[int] = None
"""
The type ID of the private appointment
"""
# @ApiMember(DataType="integer", Description="The Instructor ID of the appointment", Format="int32", IsRequired=true, Name="InstructorId", ParameterType="query")
instructor_id: Optional[int] = None
"""
The Instructor ID of the appointment
"""
# @ApiMember(DataType="integer", Description="IThe location ID of the appointment", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")
location_id: Optional[int] = None
"""
IThe location ID of the appointment
"""
# @ApiMember(DataType="string", Description="The start time of the appointment.", Format="date-time", IsRequired=true, Name="AppointmentStart", ParameterType="query")
appointment_start: Optional[datetime.datetime] = None
"""
The start time of the appointment.
"""
# @ApiMember(DataType="string", Description="The name of the student", IsRequired=true, Name="StudentName", ParameterType="query")
student_name: Optional[str] = None
"""
The name of the student
"""
# @ApiMember(DataType="string", Description="Online reference number of this appointment", Name="RefNumber", ParameterType="query")
ref_number: Optional[str] = None
"""
Online reference number of this appointment
"""
# @ApiMember(DataType="integer", Description="The AIM customer account # of the customer. Optional.", Format="int32", Name="CustomerAcct", ParameterType="query")
customer_acct: Optional[int] = None
"""
The AIM customer account # of the customer. Optional.
"""
# @ApiMember(DataType="object", Description="Customer Information", Name="CustomerInfo", ParameterType="query")
customer_info: Optional[CustomerInfo] = None
"""
Customer Information
"""
# @ApiMember(DataType="array", Description="Additional Customer or Appointment info", Name="FormInputList", ParameterType="query")
form_input_list: Optional[List[FormInput]] = None
"""
Additional Customer or Appointment info
"""
# @ApiMember(DataType="object", Description="Credit Card info of the customer for this appointment", Name="CcInfo", ParameterType="query")
cc_info: Optional[CcInfo] = None
"""
Credit Card info of the customer for this appointment
"""
# @ApiMember(DataType="string", Description="Notes on this appointment", Name="Notes", ParameterType="query")
notes: Optional[str] = None
"""
Notes on this appointment
"""
Python PostSchedulingPrivateRequest 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.
POST /api/PostSchedulingPrivate HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<PostSchedulingPrivateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppointmentStart>0001-01-01T00:00:00</AppointmentStart>
<CcInfo>
<CardType>String</CardType>
<Expiration>String</Expiration>
<LastFour>String</LastFour>
<Primary>false</Primary>
<ReasonOnFile>String</ReasonOnFile>
<TokenPk>0</TokenPk>
<TokenStr>String</TokenStr>
</CcInfo>
<CustomerAcct>0</CustomerAcct>
<CustomerInfo>
<Addr1>String</Addr1>
<Addr2>String</Addr2>
<City>String</City>
<Country>String</Country>
<Email>String</Email>
<Name>String</Name>
<Phone>String</Phone>
<St>String</St>
<WebId>0</WebId>
<Zip>String</Zip>
</CustomerInfo>
<FormInputList>
<FormInput>
<Encrypted>false</Encrypted>
<Key>String</Key>
<Value>String</Value>
</FormInput>
</FormInputList>
<InstructorId>0</InstructorId>
<LocationId>0</LocationId>
<Notes>String</Notes>
<RefNumber>String</RefNumber>
<StudentName>String</StudentName>
<TypeId>0</TypeId>
</PostSchedulingPrivateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<PostSchedulingPrivateResponse 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>
</PostSchedulingPrivateResponse>