| POST, GET | /api/C2BPostContract |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
/**
* C2BPostContractRequires active-e Contracts Service.
*/
@DataContract
public static class C2BPostContractRequest extends 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")
public Long TeacherId = 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")
public String SchoolName = 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")
public Long AIMSchoolId = 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")
public String Stloc = 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")
public Long InstrumentId = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Sku", ParameterType="query")
public String Sku = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Desc", ParameterType="query")
public String Desc = null;
/**
* The ID from the C2BGradeGeneric object
*/
@DataMember
@ApiMember(DataType="integer", Description="The ID from the C2BGradeGeneric object", Format="int64", Name="RateId", ParameterType="query")
public Long RateId = null;
/**
*
*/
@DataMember
@ApiMember(DataType="object", Description="", Name="Rate", ParameterType="query")
public Rate Rate = null;
/**
*
*/
@DataMember
@ApiMember(DataType="array", Description="", Name="AccessoryIdList", ParameterType="query")
public ArrayList<Long> AccessoryIdList = null;
/**
*
*/
@DataMember
@ApiMember(DataType="array", Description="", Name="AccessoryList", ParameterType="query")
public ArrayList<Accessory> AccessoryList = null;
/**
*
*/
@DataMember
@ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
public ArrayList<FormInput> FormInputList = null;
/**
*
*/
@DataMember
@ApiMember(DataType="object", Description="", Name="CcInfo", ParameterType="query")
public CcInfo CcInfo = null;
/**
*
*/
@DataMember
@ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")
public CustomerInfo CustomerInfo = null;
/**
*
*/
@DataMember
@ApiMember(DataType="integer", Description="", Format="int32", Name="CusAcct", ParameterType="query")
public Integer CusAcct = null;
/**
*
*/
@DataMember
@ApiMember(DataType="int", Description="", Name="Cat", ParameterType="query")
public Integer Cat = null;
/**
*
*/
@DataMember
@ApiMember(DataType="int", Description="", Name="Sub", ParameterType="query")
public Integer Sub = null;
@DataMember
public Boolean ReturnTopic = null;
@DataMember
public Long StatusId = null;
@DataMember
public String CardTerminalId = null;
public Long getTeacherId() { return TeacherId; }
public C2BPostContractRequest setTeacherId(Long value) { this.TeacherId = value; return this; }
public String getSchoolName() { return SchoolName; }
public C2BPostContractRequest setSchoolName(String value) { this.SchoolName = value; return this; }
public Long getAimSchoolId() { return AIMSchoolId; }
public C2BPostContractRequest setAimSchoolId(Long value) { this.AIMSchoolId = value; return this; }
public String getStloc() { return Stloc; }
public C2BPostContractRequest setStloc(String value) { this.Stloc = value; return this; }
public Long getInstrumentId() { return InstrumentId; }
public C2BPostContractRequest setInstrumentId(Long value) { this.InstrumentId = value; return this; }
public String getSku() { return Sku; }
public C2BPostContractRequest setSku(String value) { this.Sku = value; return this; }
public String getDesc() { return Desc; }
public C2BPostContractRequest setDesc(String value) { this.Desc = value; return this; }
public Long getRateId() { return RateId; }
public C2BPostContractRequest setRateId(Long value) { this.RateId = value; return this; }
public Rate getRate() { return Rate; }
public C2BPostContractRequest setRate(Rate value) { this.Rate = value; return this; }
public ArrayList<Long> getAccessoryIdList() { return AccessoryIdList; }
public C2BPostContractRequest setAccessoryIdList(ArrayList<Long> value) { this.AccessoryIdList = value; return this; }
public ArrayList<Accessory> getAccessoryList() { return AccessoryList; }
public C2BPostContractRequest setAccessoryList(ArrayList<Accessory> value) { this.AccessoryList = value; return this; }
public ArrayList<FormInput> getFormInputList() { return FormInputList; }
public C2BPostContractRequest setFormInputList(ArrayList<FormInput> value) { this.FormInputList = value; return this; }
public CcInfo getCcInfo() { return CcInfo; }
public C2BPostContractRequest setCcInfo(CcInfo value) { this.CcInfo = value; return this; }
public CustomerInfo getCustomerInfo() { return CustomerInfo; }
public C2BPostContractRequest setCustomerInfo(CustomerInfo value) { this.CustomerInfo = value; return this; }
public Integer getCusAcct() { return CusAcct; }
public C2BPostContractRequest setCusAcct(Integer value) { this.CusAcct = value; return this; }
public Integer getCat() { return Cat; }
public C2BPostContractRequest setCat(Integer value) { this.Cat = value; return this; }
public Integer getSub() { return Sub; }
public C2BPostContractRequest setSub(Integer value) { this.Sub = value; return this; }
public Boolean isReturnTopic() { return ReturnTopic; }
public C2BPostContractRequest setReturnTopic(Boolean value) { this.ReturnTopic = value; return this; }
public Long getStatusId() { return StatusId; }
public C2BPostContractRequest setStatusId(Long value) { this.StatusId = value; return this; }
public String getCardTerminalId() { return CardTerminalId; }
public C2BPostContractRequest setCardTerminalId(String value) { this.CardTerminalId = value; return this; }
}
@DataContract
public static class BaseSecureRequest extends BaseRequest
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
public String Token = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
public String DeviceId = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
public String AppId = null;
public String getToken() { return Token; }
public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
public String getDeviceId() { return DeviceId; }
public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
public String getAppId() { return AppId; }
public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
}
@DataContract
public static 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")
public String ApiKey = null;
@DataMember
@ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
public String OAuthToken = null;
public String getApiKey() { return ApiKey; }
public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
public String getOAuthToken() { return OAuthToken; }
public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
}
@DataContract(Name="Rate")
public static class Rate
{
@DataMember
public String PlanCode = null;
@DataMember
public Integer Level = null;
@DataMember
public String Grade = null;
@DataMember
public BigDecimal DownPay = null;
@DataMember
public BigDecimal MoPay = null;
@DataMember
public BigDecimal DownMaint = null;
@DataMember
public BigDecimal MoMaint = null;
@DataMember
public String RdfType = null;
@DataMember
public Long ContractDefaultId = null;
/**
* The Number of Months covered by the downpayment
*/
@DataMember
@ApiMember(DataType="int", Description="The Number of Months covered by the downpayment", Name="Months")
public Integer Months = null;
@DataMember
public BigDecimal DownLease = null;
@DataMember
public BigDecimal MoLease = null;
public String getPlanCode() { return PlanCode; }
public Rate setPlanCode(String value) { this.PlanCode = value; return this; }
public Integer getLevel() { return Level; }
public Rate setLevel(Integer value) { this.Level = value; return this; }
public String getGrade() { return Grade; }
public Rate setGrade(String value) { this.Grade = value; return this; }
public BigDecimal getDownPay() { return DownPay; }
public Rate setDownPay(BigDecimal value) { this.DownPay = value; return this; }
public BigDecimal getMoPay() { return MoPay; }
public Rate setMoPay(BigDecimal value) { this.MoPay = value; return this; }
public BigDecimal getDownMaint() { return DownMaint; }
public Rate setDownMaint(BigDecimal value) { this.DownMaint = value; return this; }
public BigDecimal getMoMaint() { return MoMaint; }
public Rate setMoMaint(BigDecimal value) { this.MoMaint = value; return this; }
public String getRdfType() { return RdfType; }
public Rate setRdfType(String value) { this.RdfType = value; return this; }
public Long getContractDefaultId() { return ContractDefaultId; }
public Rate setContractDefaultId(Long value) { this.ContractDefaultId = value; return this; }
public Integer getMonths() { return Months; }
public Rate setMonths(Integer value) { this.Months = value; return this; }
public BigDecimal getDownLease() { return DownLease; }
public Rate setDownLease(BigDecimal value) { this.DownLease = value; return this; }
public BigDecimal getMoLease() { return MoLease; }
public Rate setMoLease(BigDecimal value) { this.MoLease = value; return this; }
}
@DataContract(Name="Accessory")
public static class Accessory
{
@DataMember
public String Desc = null;
@DataMember
public BigDecimal Price = null;
@DataMember
public String Type = null;
@DataMember
public Integer CatNum = null;
@DataMember
public String Sku = null;
@DataMember
public Boolean Report = null;
public String getDesc() { return Desc; }
public Accessory setDesc(String value) { this.Desc = value; return this; }
public BigDecimal getPrice() { return Price; }
public Accessory setPrice(BigDecimal value) { this.Price = value; return this; }
public String getType() { return Type; }
public Accessory setType(String value) { this.Type = value; return this; }
public Integer getCatNum() { return CatNum; }
public Accessory setCatNum(Integer value) { this.CatNum = value; return this; }
public String getSku() { return Sku; }
public Accessory setSku(String value) { this.Sku = value; return this; }
public Boolean isReport() { return Report; }
public Accessory setReport(Boolean value) { this.Report = value; return this; }
}
@DataContract(Name="FormInput")
public static 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")
public String Key = null;
/**
* Value of the Input Field.
*/
@DataMember
@ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
public String Value = 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")
public Boolean Encrypted = null;
public String getKey() { return Key; }
public FormInput setKey(String value) { this.Key = value; return this; }
public String getValue() { return Value; }
public FormInput setValue(String value) { this.Value = value; return this; }
public Boolean isEncrypted() { return Encrypted; }
public FormInput setEncrypted(Boolean value) { this.Encrypted = value; return this; }
}
@DataContract(Name="CCInfo")
public static class CcInfo
{
/**
* Token returned from processor
*/
@DataMember
@ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
public String TokenStr = null;
/**
* Card Type (VISA, MCARD, AMEX, DSCVR)
*/
@DataMember
@ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
public String CardType = null;
/**
* Last four of the card
*/
@DataMember
@ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
public String LastFour = null;
/**
* Expiration Date of the Card. (MM/YY)
*/
@DataMember
@ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
public String Expiration = null;
/**
* Reason the card is on file.
*/
@DataMember
@ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
public String ReasonOnFile = 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")
public Long TokenPk = 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")
public Boolean Primary = null;
public String getTokenStr() { return TokenStr; }
public CcInfo setTokenStr(String value) { this.TokenStr = value; return this; }
public String getCardType() { return CardType; }
public CcInfo setCardType(String value) { this.CardType = value; return this; }
public String getLastFour() { return LastFour; }
public CcInfo setLastFour(String value) { this.LastFour = value; return this; }
public String getExpiration() { return Expiration; }
public CcInfo setExpiration(String value) { this.Expiration = value; return this; }
public String getReasonOnFile() { return ReasonOnFile; }
public CcInfo setReasonOnFile(String value) { this.ReasonOnFile = value; return this; }
public Long getTokenPk() { return TokenPk; }
public CcInfo setTokenPk(Long value) { this.TokenPk = value; return this; }
public Boolean isPrimary() { return Primary; }
public CcInfo setPrimary(Boolean value) { this.Primary = value; return this; }
}
@DataContract(Name="CustomerInfo")
public static 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")
public Integer WebId = null;
/**
* Name of the customer.
*/
@DataMember
@ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")
public String Name = null;
/**
* Address line 1 of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")
public String Addr1 = null;
/**
* Address line 2 of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")
public String Addr2 = null;
/**
* City of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")
public String City = null;
/**
* State/Province of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")
public String St = null;
/**
* Zip code of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")
public String Zip = null;
/**
* Country of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")
public String Country = null;
/**
* Phone number of the customer
*/
@DataMember
@ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")
public String Phone = null;
/**
* Email address of the customer. Required.
*/
@DataMember
@ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
public String Email = null;
public Integer getWebId() { return WebId; }
public CustomerInfo setWebId(Integer value) { this.WebId = value; return this; }
public String getName() { return Name; }
public CustomerInfo setName(String value) { this.Name = value; return this; }
public String getAddr1() { return Addr1; }
public CustomerInfo setAddr1(String value) { this.Addr1 = value; return this; }
public String getAddr2() { return Addr2; }
public CustomerInfo setAddr2(String value) { this.Addr2 = value; return this; }
public String getCity() { return City; }
public CustomerInfo setCity(String value) { this.City = value; return this; }
public String getSt() { return St; }
public CustomerInfo setSt(String value) { this.St = value; return this; }
public String getZip() { return Zip; }
public CustomerInfo setZip(String value) { this.Zip = value; return this; }
public String getCountry() { return Country; }
public CustomerInfo setCountry(String value) { this.Country = value; return this; }
public String getPhone() { return Phone; }
public CustomerInfo setPhone(String value) { this.Phone = value; return this; }
public String getEmail() { return Email; }
public CustomerInfo setEmail(String value) { this.Email = value; return this; }
}
@DataContract
public static class C2BPostContractResponse extends BaseResponse
{
@DataMember
public Boolean PaymentRequired = null;
@DataMember
public String Topic = null;
@DataMember
public String WebRef = null;
@DataMember
public String BaseUrl = null;
public Boolean isPaymentRequired() { return PaymentRequired; }
public C2BPostContractResponse setPaymentRequired(Boolean value) { this.PaymentRequired = value; return this; }
public String getTopic() { return Topic; }
public C2BPostContractResponse setTopic(String value) { this.Topic = value; return this; }
public String getWebRef() { return WebRef; }
public C2BPostContractResponse setWebRef(String value) { this.WebRef = value; return this; }
public String getBaseUrl() { return BaseUrl; }
public C2BPostContractResponse setBaseUrl(String value) { this.BaseUrl = value; return this; }
}
@DataContract
public static class BaseResponse
{
/**
*
*/
@DataMember
@ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
public BaseResponseResult Status = null;
public BaseResponseResult getStatus() { return Status; }
public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
}
@DataContract
public static class BaseResponseResult
{
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
public String StatusCode = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
public String Login = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
public String ErrorCode = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
public String ErrorDisplayText = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
public String ErrorMessage = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
public String DomainName = null;
/**
*
*/
@DataMember
@ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
public String IpAddress = null;
public String getStatusCode() { return StatusCode; }
public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
public String getLogin() { return Login; }
public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
public String getErrorCode() { return ErrorCode; }
public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
public String getErrorDisplayText() { return ErrorDisplayText; }
public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
public String getErrorMessage() { return ErrorMessage; }
public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
public String getDomainName() { return DomainName; }
public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
public String getIpAddress() { return IpAddress; }
public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
}
}
Java 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>