| POST, GET | /api/C2BPostContract |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
/**
* C2BPostContractRequires active-e Contracts Service.
*/
@DataContract
open class C2BPostContractRequest : BaseSecureRequest()
{
/**
* ID of the teacher to associate the contract with.
*/
@DataMember
@ApiMember(DataType="integer", Description="ID of the teacher to associate the contract with.", Format="int64", Name="TeacherId", ParameterType="query")
var TeacherId:Long? = null
/**
* Used to associate the contract with a school by school name.
*/
@DataMember
@ApiMember(DataType="string", Description="Used to associate the contract with a school by school name.", Name="SchoolName", ParameterType="query")
var SchoolName:String? = null
/**
* Used to associate the contract with a school by the AIM School ID
*/
@DataMember
@ApiMember(DataType="string", Description="Used to associate the contract with a school by the AIM School ID", Name="AIMSchoolId", ParameterType="query")
var AIMSchoolId:Long? = null
/**
* Used to associate the contract with a location by location code.
*/
@DataMember
@ApiMember(DataType="string", Description="Used to associate the contract with a location by location code.", Name="Stloc", ParameterType="query")
var Stloc:String? = null
/**
* ID of the instrument to associate the contract with.
*/
@DataMember
@ApiMember(DataType="integer", Description="ID of the instrument to associate the contract with.", Format="int64", Name="InstrumentId", ParameterType="query")
var InstrumentId:Long? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Sku", ParameterType="query")
var Sku:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Desc", ParameterType="query")
var Desc:String? = null
/**
* The ID from the C2BGradeGeneric object
*/
@DataMember
@ApiMember(DataType="integer", Description="The ID from the C2BGradeGeneric object", Format="int64", Name="RateId", ParameterType="query")
var RateId:Long? = null
/**
*
*/
@DataMember
@ApiMember(DataType="object", Description="", Name="Rate", ParameterType="query")
var Rate:Rate? = null
/**
*
*/
@DataMember
@ApiMember(DataType="array", Description="", Name="AccessoryIdList", ParameterType="query")
var AccessoryIdList:ArrayList<Long> = ArrayList<Long>()
/**
*
*/
@DataMember
@ApiMember(DataType="array", Description="", Name="AccessoryList", ParameterType="query")
var AccessoryList:ArrayList<Accessory> = ArrayList<Accessory>()
/**
*
*/
@DataMember
@ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
var FormInputList:ArrayList<FormInput> = ArrayList<FormInput>()
/**
*
*/
@DataMember
@ApiMember(DataType="object", Description="", Name="CcInfo", ParameterType="query")
var CcInfo:CcInfo? = null
/**
*
*/
@DataMember
@ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")
var CustomerInfo:CustomerInfo? = null
/**
*
*/
@DataMember
@ApiMember(DataType="integer", Description="", Format="int32", Name="CusAcct", ParameterType="query")
var CusAcct:Int? = null
/**
*
*/
@DataMember
@ApiMember(DataType="int", Description="", Name="Cat", ParameterType="query")
var Cat:Int? = null
/**
*
*/
@DataMember
@ApiMember(DataType="int", Description="", Name="Sub", ParameterType="query")
var Sub:Int? = null
@DataMember
var ReturnTopic:Boolean? = null
@DataMember
var StatusId:Long? = null
@DataMember
var CardTerminalId:String? = null
}
@DataContract
open class BaseSecureRequest : BaseRequest()
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
var Token:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
var DeviceId:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
var AppId:String? = null
}
@DataContract
open class BaseRequest
{
/**
* This is your AIM API Key provided by Tri-Tech
*/
@DataMember
@ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
var ApiKey:String? = null
@DataMember
@ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
var OAuthToken:String? = null
}
@DataContract(Name="Rate")
open class Rate
{
@DataMember
var PlanCode:String? = null
@DataMember
var Level:Int? = null
@DataMember
var Grade:String? = null
@DataMember
var DownPay:BigDecimal? = null
@DataMember
var MoPay:BigDecimal? = null
@DataMember
var DownMaint:BigDecimal? = null
@DataMember
var MoMaint:BigDecimal? = null
@DataMember
var RdfType:String? = null
@DataMember
var ContractDefaultId:Long? = null
/**
* The Number of Months covered by the downpayment
*/
@DataMember
@ApiMember(DataType="int", Description="The Number of Months covered by the downpayment", Name="Months")
var Months:Int? = null
@DataMember
var DownLease:BigDecimal? = null
@DataMember
var MoLease:BigDecimal? = null
}
@DataContract(Name="Accessory")
open class Accessory
{
@DataMember
var Desc:String? = null
@DataMember
var Price:BigDecimal? = null
@DataMember
var Type:String? = null
@DataMember
var CatNum:Int? = null
@DataMember
var Sku:String? = null
@DataMember
var Report:Boolean? = null
}
@DataContract(Name="FormInput")
open class FormInput
{
/**
* Field Name of the Input Field
*/
@DataMember
@ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
var Key:String? = null
/**
* Value of the Input Field.
*/
@DataMember
@ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
var Value:String? = null
/**
* Whether or not the field is encryped with the C2B encryption key.
*/
@DataMember
@ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
var Encrypted:Boolean? = null
}
@DataContract(Name="CCInfo")
open class CcInfo
{
/**
* Token returned from processor
*/
@DataMember
@ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
var TokenStr:String? = null
/**
* Card Type (VISA, MCARD, AMEX, DSCVR)
*/
@DataMember
@ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
var CardType:String? = null
/**
* Last four of the card
*/
@DataMember
@ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
var LastFour:String? = null
/**
* Expiration Date of the Card. (MM/YY)
*/
@DataMember
@ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
var Expiration:String? = null
/**
* Reason the card is on file.
*/
@DataMember
@ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
var ReasonOnFile:String? = null
/**
* ID of the existing Token Record in AIM, if applicable
*/
@DataMember
@ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
var TokenPk:Long? = null
/**
* Is this the customer's primary card? Defaults to false.
*/
@DataMember
@ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
var Primary:Boolean? = null
}
@DataContract(Name="CustomerInfo")
open class CustomerInfo
{
/**
* The WebId of the customer. Optional.
*/
@DataMember
@ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", IsRequired=true, Name="WebId", ParameterType="query")
var WebId:Int? = null
/**
* Name of the customer.
*/
@DataMember
@ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")
var Name:String? = null
/**
* Address line 1 of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")
var Addr1:String? = null
/**
* Address line 2 of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")
var Addr2:String? = null
/**
* City of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")
var City:String? = null
/**
* State/Province of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")
var St:String? = null
/**
* Zip code of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")
var Zip:String? = null
/**
* Country of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")
var Country:String? = null
/**
* Phone number of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")
var Phone:String? = null
/**
* Email address of the customer. Required.
*/
@DataMember
@ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
var Email:String? = null
}
@DataContract
open class C2BPostContractResponse : BaseResponse()
{
@DataMember
var PaymentRequired:Boolean? = null
@DataMember
var Topic:String? = null
@DataMember
var WebRef:String? = null
@DataMember
var BaseUrl:String? = null
}
@DataContract
open class BaseResponse
{
/**
*
*/
@DataMember
@ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
var Status:BaseResponseResult? = null
}
@DataContract
open class BaseResponseResult
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
var StatusCode:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
var Login:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
var ErrorCode:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
var ErrorDisplayText:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
var ErrorMessage:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
var DomainName:String? = null
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
var IpAddress:String? = null
}
Kotlin C2BPostContractRequest 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/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>