AIM Web Services

PostSchedulingPrivateRequest

PostSchedulingPrivate
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
POST	/api/PostSchedulingPrivate

**PostSchedulingPrivateRequest** Parameters:
Name	Parameter	Data Type	Required	Description
TypeId	query	integer	Yes	The type ID of the private appointment
InstructorId	query	integer	Yes	The Instructor ID of the appointment
LocationId	query	integer	Yes	IThe location ID of the appointment
AppointmentStart	query	string	Yes	The start time of the appointment.
StudentName	query	string	Yes	The name of the student
RefNumber	query	string	No	Online reference number of this appointment
CustomerAcct	query	integer	No	The AIM customer account # of the customer. Optional.
CustomerInfo	query	object	No	Customer Information
FormInputList	query	array	No	Additional Customer or Appointment info
CcInfo	query	object	No	Credit Card info of the customer for this appointment
Notes	query	string	No	Notes on this appointment

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**CustomerInfo** Parameters:
Name	Parameter	Data Type	Required	Description
WebId	query	integer	Yes	The WebId of the customer. Optional.
Name	query	string	Yes	Name of the customer.
Addr1	query	string	No	Address line 1 of the customer
Addr2	query	string	No	Address line 2 of the customer
City	query	string	No	City of the customer
St	query	string	No	State/Province of the customer
Zip	query	string	No	Zip code of the customer
Country	query	string	No	Country of the customer
Phone	query	string	No	Phone number of the customer
Email	query	string	Yes	Email address of the customer. Required.

**FormInput** Parameters:
Name	Parameter	Data Type	Required	Description
Key	query	string	Yes	Field Name of the Input Field
Value	query	string	Yes	Value of the Input Field.
Encrypted	query	boolean	Yes	Whether or not the field is encryped with the C2B encryption key.

**CcInfo** Parameters:
Name	Parameter	Data Type	Required	Description
TokenStr	query	string	Yes	Token returned from processor
CardType	query	string	Yes	Card Type (VISA, MCARD, AMEX, DSCVR)
LastFour	query	string	Yes	Last four of the card
Expiration	query	string	No	Expiration Date of the Card. (MM/YY)
ReasonOnFile	query	string	No	Reason the card is on file.
TokenPk	query	integer	No	ID of the existing Token Record in AIM, if applicable
Primary	query	boolean	No	Is this the customer's primary card? Defaults to false.

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

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/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>

AIM Web Services

PostSchedulingPrivateRequest

PostSchedulingPrivate Requires active-e Lesson Scheduling Service

HTTP + XML

PostSchedulingPrivate
Requires active-e Lesson Scheduling Service