| POST, GET | /api/C2BPostContract |
|---|
namespace AIM.WebService
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type BaseResponseResult() =
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
member val StatusCode:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
member val Login:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
member val ErrorCode:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
member val ErrorDisplayText:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
member val ErrorMessage:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
member val DomainName:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
member val IpAddress:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseResponse() =
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
member val Status:BaseResponseResult = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BPostContractResponse() =
inherit BaseResponse()
[<DataMember>]
member val PaymentRequired:Boolean = new Boolean() with get,set
[<DataMember>]
member val Topic:String = null with get,set
[<DataMember>]
member val WebRef:String = null with get,set
[<DataMember>]
member val BaseUrl:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type 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")>]
member val ApiKey:String = null with get,set
[<DataMember>]
[<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
member val OAuthToken:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseSecureRequest() =
inherit BaseRequest()
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
member val Token:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
member val DeviceId:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
member val AppId:String = null with get,set
[<DataContract(Name="Rate")>]
[<AllowNullLiteral>]
type Rate() =
[<DataMember>]
member val PlanCode:String = null with get,set
[<DataMember>]
member val Level:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember>]
member val Grade:String = null with get,set
[<DataMember>]
member val DownPay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val MoPay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val DownMaint:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val MoMaint:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val RdfType:String = null with get,set
[<DataMember>]
member val ContractDefaultId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<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")>]
member val Months:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember>]
member val DownLease:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val MoLease:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataContract(Name="Accessory")>]
[<AllowNullLiteral>]
type Accessory() =
[<DataMember>]
member val Desc:String = null with get,set
[<DataMember>]
member val Price:Decimal = new Decimal() with get,set
[<DataMember>]
member val Type:String = null with get,set
[<DataMember>]
member val CatNum:Int32 = new Int32() with get,set
[<DataMember>]
member val Sku:String = null with get,set
[<DataMember>]
member val Report:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataContract(Name="FormInput")>]
[<AllowNullLiteral>]
type 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")>]
member val Key:String = null with get,set
///<summary>
///Value of the Input Field.
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")>]
member val Value:String = null with get,set
///<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")>]
member val Encrypted:Boolean = new Boolean() with get,set
[<DataContract(Name="CCInfo")>]
[<AllowNullLiteral>]
type CcInfo() =
///<summary>
///Token returned from processor
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")>]
member val TokenStr:String = null with get,set
///<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")>]
member val CardType:String = null with get,set
///<summary>
///Last four of the card
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")>]
member val LastFour:String = null with get,set
///<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")>]
member val Expiration:String = null with get,set
///<summary>
///Reason the card is on file.
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")>]
member val ReasonOnFile:String = null with get,set
///<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")>]
member val TokenPk:Nullable<Int64> = new Nullable<Int64>() with get,set
///<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")>]
member val Primary:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataContract(Name="CustomerInfo")>]
[<AllowNullLiteral>]
type 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")>]
member val WebId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Name of the customer.
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")>]
member val Name:String = null with get,set
///<summary>
///Address line 1 of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")>]
member val Addr1:String = null with get,set
///<summary>
///Address line 2 of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")>]
member val Addr2:String = null with get,set
///<summary>
///City of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")>]
member val City:String = null with get,set
///<summary>
///State/Province of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")>]
member val St:String = null with get,set
///<summary>
///Zip code of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")>]
member val Zip:String = null with get,set
///<summary>
///Country of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")>]
member val Country:String = null with get,set
///<summary>
///Phone number of the customer
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")>]
member val Phone:String = null with get,set
///<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")>]
member val Email:String = null with get,set
///<summary>
///C2BPostContractRequires active-e Contracts Service.
///</summary>
[<DataContract>]
[<AllowNullLiteral>]
type C2BPostContractRequest() =
inherit BaseSecureRequest()
///<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")>]
member val TeacherId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<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")>]
member val SchoolName:String = null with get,set
///<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")>]
member val AIMSchoolId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<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")>]
member val Stloc:String = null with get,set
///<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")>]
member val InstrumentId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="Sku", ParameterType="query")>]
member val Sku:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="Desc", ParameterType="query")>]
member val Desc:String = null with get,set
///<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")>]
member val RateId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="object", Description="", Name="Rate", ParameterType="query")>]
member val Rate:Rate = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="array", Description="", Name="AccessoryIdList", ParameterType="query")>]
member val AccessoryIdList:ResizeArray<Int64> = new ResizeArray<Int64>() with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="array", Description="", Name="AccessoryList", ParameterType="query")>]
member val AccessoryList:ResizeArray<Accessory> = new ResizeArray<Accessory>() with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")>]
member val FormInputList:ResizeArray<FormInput> = new ResizeArray<FormInput>() with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="object", Description="", Name="CcInfo", ParameterType="query")>]
member val CcInfo:CcInfo = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")>]
member val CustomerInfo:CustomerInfo = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="", Format="int32", Name="CusAcct", ParameterType="query")>]
member val CusAcct:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="int", Description="", Name="Cat", ParameterType="query")>]
member val Cat:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="int", Description="", Name="Sub", ParameterType="query")>]
member val Sub:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember>]
member val ReturnTopic:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember>]
member val StatusId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember>]
member val CardTerminalId:String = null with get,set
F# 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>