| POST, GET | /api/C2BPostContract |
|---|
// @DataContract
export class BaseRequest
{
/** @description 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 ApiKey: string;
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
public OAuthToken: string;
public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}
// @DataContract
export class BaseSecureRequest extends BaseRequest
{
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
public Token: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
public DeviceId: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
public AppId: string;
public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract
export class BaseResponseResult
{
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
public StatusCode: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
public Login: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
public ErrorCode: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
public ErrorDisplayText: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
public ErrorMessage: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
public DomainName: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
public IpAddress: string;
public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}
// @DataContract
export class BaseResponse
{
/** @description */
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
public Status: BaseResponseResult;
public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}
// @DataContract
export class C2BPostContractResponse extends BaseResponse
{
// @DataMember
public PaymentRequired: boolean;
// @DataMember
public Topic: string;
// @DataMember
public WebRef: string;
// @DataMember
public BaseUrl: string;
public constructor(init?: Partial<C2BPostContractResponse>) { super(init); (Object as any).assign(this, init); }
}
// @DataContract(Name="Rate")
export class Rate
{
// @DataMember
public PlanCode: string;
// @DataMember
public Level?: number;
// @DataMember
public Grade: string;
// @DataMember
public DownPay?: number;
// @DataMember
public MoPay?: number;
// @DataMember
public DownMaint?: number;
// @DataMember
public MoMaint?: number;
// @DataMember
public RdfType: string;
// @DataMember
public ContractDefaultId?: number;
/** @description The Number of Months covered by the downpayment */
// @DataMember
// @ApiMember(DataType="int", Description="The Number of Months covered by the downpayment", Name="Months")
public Months?: number;
// @DataMember
public DownLease?: number;
// @DataMember
public MoLease?: number;
public constructor(init?: Partial<Rate>) { (Object as any).assign(this, init); }
}
// @DataContract(Name="Accessory")
export class Accessory
{
// @DataMember
public Desc: string;
// @DataMember
public Price: number;
// @DataMember
public Type: string;
// @DataMember
public CatNum: number;
// @DataMember
public Sku: string;
// @DataMember
public Report?: boolean;
public constructor(init?: Partial<Accessory>) { (Object as any).assign(this, init); }
}
// @DataContract(Name="FormInput")
export class FormInput
{
/** @description Field Name of the Input Field */
// @DataMember
// @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
public Key: string;
/** @description Value of the Input Field. */
// @DataMember
// @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
public Value: string;
/** @description 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 Encrypted: boolean;
public constructor(init?: Partial<FormInput>) { (Object as any).assign(this, init); }
}
// @DataContract(Name="CCInfo")
export class CcInfo
{
/** @description Token returned from processor */
// @DataMember
// @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
public TokenStr: string;
/** @description Card Type (VISA, MCARD, AMEX, DSCVR) */
// @DataMember
// @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
public CardType: string;
/** @description Last four of the card */
// @DataMember
// @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
public LastFour: string;
/** @description Expiration Date of the Card. (MM/YY) */
// @DataMember
// @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
public Expiration: string;
/** @description Reason the card is on file. */
// @DataMember
// @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
public ReasonOnFile: string;
/** @description 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 TokenPk?: number;
/** @description 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 Primary?: boolean;
public constructor(init?: Partial<CcInfo>) { (Object as any).assign(this, init); }
}
// @DataContract(Name="CustomerInfo")
export class CustomerInfo
{
/** @description 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 WebId: number;
/** @description Name of the customer. */
// @DataMember
// @ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="query")
public Name: string;
/** @description Address line 1 of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="query")
public Addr1: string;
/** @description Address line 2 of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="query")
public Addr2: string;
/** @description City of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="query")
public City: string;
/** @description State/Province of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="query")
public St: string;
/** @description Zip code of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="query")
public Zip: string;
/** @description Country of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="query")
public Country: string;
/** @description Phone number of the customer */
// @DataMember
// @ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="query")
public Phone: string;
/** @description Email address of the customer. Required. */
// @DataMember
// @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="query")
public Email: string;
public constructor(init?: Partial<CustomerInfo>) { (Object as any).assign(this, init); }
}
/** @description C2BPostContractRequires active-e Contracts Service. */
// @DataContract
export class C2BPostContractRequest extends BaseSecureRequest
{
/** @description 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 TeacherId?: number;
/** @description 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 SchoolName: string;
/** @description 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 AIMSchoolId?: number;
/** @description 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 Stloc: string;
/** @description 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 InstrumentId?: number;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Sku", ParameterType="query")
public Sku: string;
/** @description */
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Desc", ParameterType="query")
public Desc: string;
/** @description The ID from the C2BGradeGeneric object */
// @DataMember
// @ApiMember(DataType="integer", Description="The ID from the C2BGradeGeneric object", Format="int64", Name="RateId", ParameterType="query")
public RateId?: number;
/** @description */
// @DataMember
// @ApiMember(DataType="object", Description="", Name="Rate", ParameterType="query")
public Rate: Rate;
/** @description */
// @DataMember
// @ApiMember(DataType="array", Description="", Name="AccessoryIdList", ParameterType="query")
public AccessoryIdList: number[];
/** @description */
// @DataMember
// @ApiMember(DataType="array", Description="", Name="AccessoryList", ParameterType="query")
public AccessoryList: Accessory[];
/** @description */
// @DataMember
// @ApiMember(DataType="array", Description="", Name="FormInputList", ParameterType="query")
public FormInputList: FormInput[];
/** @description */
// @DataMember
// @ApiMember(DataType="object", Description="", Name="CcInfo", ParameterType="query")
public CcInfo: CcInfo;
/** @description */
// @DataMember
// @ApiMember(DataType="object", Description="", Name="CustomerInfo", ParameterType="query")
public CustomerInfo: CustomerInfo;
/** @description */
// @DataMember
// @ApiMember(DataType="integer", Description="", Format="int32", Name="CusAcct", ParameterType="query")
public CusAcct?: number;
/** @description */
// @DataMember
// @ApiMember(DataType="int", Description="", Name="Cat", ParameterType="query")
public Cat?: number;
/** @description */
// @DataMember
// @ApiMember(DataType="int", Description="", Name="Sub", ParameterType="query")
public Sub?: number;
// @DataMember
public ReturnTopic?: boolean;
// @DataMember
public StatusId?: number;
// @DataMember
public CardTerminalId: string;
public constructor(init?: Partial<C2BPostContractRequest>) { super(init); (Object as any).assign(this, init); }
}
TypeScript C2BPostContractRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"TeacherId":0,"SchoolName":"String","AIMSchoolId":0,"Stloc":"String","InstrumentId":0,"Sku":"String","Desc":"String","RateId":0,"Rate":{"PlanCode":"String","Level":0,"Grade":"String","DownPay":0,"MoPay":0,"DownMaint":0,"MoMaint":0,"RdfType":"String","ContractDefaultId":0,"Months":0,"DownLease":0,"MoLease":0},"AccessoryIdList":[0],"AccessoryList":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"CcInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"CustomerInfo":{"WebId":0,"Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Country":"String","Phone":"String","Email":"String"},"CusAcct":0,"Cat":0,"Sub":0,"ReturnTopic":false,"StatusId":0,"CardTerminalId":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"PaymentRequired":false,"Topic":"String","WebRef":"String","BaseUrl":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}