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