AIM Web Services

C2BPostContractRequest

C2BPostContract
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET	/api/C2BPostContract

**C2BPostContractRequest** Parameters:
Name	Parameter	Data Type	Required	Description
TeacherId	query	integer	No	ID of the teacher to associate the contract with.
SchoolName	query	string	No	Used to associate the contract with a school by school name.
AIMSchoolId	query	string	No	Used to associate the contract with a school by the AIM School ID
Stloc	query	string	No	Used to associate the contract with a location by location code.
InstrumentId	query	integer	No	ID of the instrument to associate the contract with.
Sku	query	string	No
Desc	query	string	No
RateId	query	integer	No	The ID from the C2BGradeGeneric object
Rate	query	object	No
AccessoryIdList	query	array	No
AccessoryList	query	array	No
FormInputList	query	array	No
CcInfo	query	object	No
CustomerInfo	query	object	No
CusAcct	query	integer	No
Cat	query	int	No
Sub	query	int	No
ReturnTopic	body	bool?	No
StatusId	body	long?	No
CardTerminalId	body	string	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

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

**Rate** Parameters:
Name	Parameter	Data Type	Required	Description
PlanCode	form	string	No
Level	form	int?	No
Grade	form	string	No
DownPay	form	decimal?	No
MoPay	form	decimal?	No
DownMaint	form	decimal?	No
MoMaint	form	decimal?	No
RdfType	form	string	No
ContractDefaultId	form	long?	No
Months	form	int	No	The Number of Months covered by the downpayment
DownLease	form	decimal?	No
MoLease	form	decimal?	No

**Accessory** Parameters:
Name	Parameter	Data Type	Required
Desc	form	string	No
Price	form	decimal	No
Type	form	string	No
CatNum	form	int	No
Sku	form	string	No
Report	form	bool?	No

**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.

**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.

**C2BPostContractResponse** Parameters:
Name	Parameter	Data Type	Required
PaymentRequired	form	bool	No
Topic	form	string	No
WebRef	form	string	No
BaseUrl	form	string	No

**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/C2BPostContract HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<C2BPostContractRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <AIMSchoolId>0</AIMSchoolId>
  <AccessoryIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </AccessoryIdList>
  <AccessoryList>
    <Accessory>
      <CatNum>0</CatNum>
      <Desc>String</Desc>
      <Price>0</Price>
      <Report>false</Report>
      <Sku>String</Sku>
      <Type>String</Type>
    </Accessory>
  </AccessoryList>
  <CardTerminalId>String</CardTerminalId>
  <Cat>0</Cat>
  <CcInfo>
    <CardType>String</CardType>
    <Expiration>String</Expiration>
    <LastFour>String</LastFour>
    <Primary>false</Primary>
    <ReasonOnFile>String</ReasonOnFile>
    <TokenPk>0</TokenPk>
    <TokenStr>String</TokenStr>
  </CcInfo>
  <CusAcct>0</CusAcct>
  <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>
  <Desc>String</Desc>
  <FormInputList>
    <FormInput>
      <Encrypted>false</Encrypted>
      <Key>String</Key>
      <Value>String</Value>
    </FormInput>
  </FormInputList>
  <InstrumentId>0</InstrumentId>
  <Rate>
    <ContractDefaultId>0</ContractDefaultId>
    <DownLease>0</DownLease>
    <DownMaint>0</DownMaint>
    <DownPay>0</DownPay>
    <Grade>String</Grade>
    <Level>0</Level>
    <MoLease>0</MoLease>
    <MoMaint>0</MoMaint>
    <MoPay>0</MoPay>
    <Months>0</Months>
    <PlanCode>String</PlanCode>
    <RdfType>String</RdfType>
  </Rate>
  <RateId>0</RateId>
  <ReturnTopic>false</ReturnTopic>
  <SchoolName>String</SchoolName>
  <Sku>String</Sku>
  <StatusId>0</StatusId>
  <Stloc>String</Stloc>
  <Sub>0</Sub>
  <TeacherId>0</TeacherId>
</C2BPostContractRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<C2BPostContractResponse 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>
  <BaseUrl>String</BaseUrl>
  <PaymentRequired>false</PaymentRequired>
  <Topic>String</Topic>
  <WebRef>String</WebRef>
</C2BPostContractResponse>

AIM Web Services

C2BPostContractRequest

C2BPostContract Requires active-e Contracts Service.

HTTP + XML

C2BPostContract
Requires active-e Contracts Service.