AIM Web Services

<back to all web services

C2BPostContractRequest

C2BPostContract
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET/api/C2BPostContract
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class C2BPostContractResponse extends BaseResponse {
    /** @param {{PaymentRequired?:boolean,Topic?:string,WebRef?:string,BaseUrl?:string,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {boolean} */
    PaymentRequired;
    /** @type {string} */
    Topic;
    /** @type {string} */
    WebRef;
    /** @type {string} */
    BaseUrl;
}
export class Rate {
    /** @param {{PlanCode?:string,Level?:number,Grade?:string,DownPay?:number,MoPay?:number,DownMaint?:number,MoMaint?:number,RdfType?:string,ContractDefaultId?:number,Months?:number,DownLease?:number,MoLease?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PlanCode;
    /** @type {?number} */
    Level;
    /** @type {string} */
    Grade;
    /** @type {?number} */
    DownPay;
    /** @type {?number} */
    MoPay;
    /** @type {?number} */
    DownMaint;
    /** @type {?number} */
    MoMaint;
    /** @type {string} */
    RdfType;
    /** @type {?number} */
    ContractDefaultId;
    /**
     * @type {?number}
     * @description The Number of Months covered by the downpayment */
    Months;
    /** @type {?number} */
    DownLease;
    /** @type {?number} */
    MoLease;
}
export class Accessory {
    /** @param {{Desc?:string,Price?:number,Type?:string,CatNum?:number,Sku?:string,Report?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Desc;
    /** @type {number} */
    Price;
    /** @type {string} */
    Type;
    /** @type {number} */
    CatNum;
    /** @type {string} */
    Sku;
    /** @type {?boolean} */
    Report;
}
export class FormInput {
    /** @param {{Key?:string,Value?:string,Encrypted?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Field Name of the Input Field */
    Key;
    /**
     * @type {string}
     * @description Value of the Input Field. */
    Value;
    /**
     * @type {boolean}
     * @description Whether or not the field is encryped with the C2B encryption key. */
    Encrypted;
}
export class CcInfo {
    /** @param {{TokenStr?:string,CardType?:string,LastFour?:string,Expiration?:string,ReasonOnFile?:string,TokenPk?:number,Primary?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description Token returned from processor */
    TokenStr;
    /**
     * @type {string}
     * @description Card Type (VISA, MCARD, AMEX, DSCVR) */
    CardType;
    /**
     * @type {string}
     * @description Last four of the card */
    LastFour;
    /**
     * @type {string}
     * @description Expiration Date of the Card. (MM/YY) */
    Expiration;
    /**
     * @type {string}
     * @description Reason the card is on file. */
    ReasonOnFile;
    /**
     * @type {?number}
     * @description ID of the existing Token Record in AIM, if applicable */
    TokenPk;
    /**
     * @type {?boolean}
     * @description Is this the customer's primary card? Defaults to false. */
    Primary;
}
export class CustomerInfo {
    /** @param {{WebId?:number,Name?:string,Addr1?:string,Addr2?:string,City?:string,St?:string,Zip?:string,Country?:string,Phone?:string,Email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The WebId of the customer. Optional. */
    WebId;
    /**
     * @type {string}
     * @description Name of the customer. */
    Name;
    /**
     * @type {string}
     * @description Address line 1 of the customer */
    Addr1;
    /**
     * @type {string}
     * @description Address line 2 of the customer */
    Addr2;
    /**
     * @type {string}
     * @description City of the customer */
    City;
    /**
     * @type {string}
     * @description State/Province of the customer */
    St;
    /**
     * @type {string}
     * @description Zip code of the customer */
    Zip;
    /**
     * @type {string}
     * @description Country of the customer */
    Country;
    /**
     * @type {string}
     * @description Phone number of the customer */
    Phone;
    /**
     * @type {string}
     * @description Email address of the customer. Required. */
    Email;
}
export class C2BPostContractRequest extends BaseSecureRequest {
    /** @param {{TeacherId?:number,SchoolName?:string,AIMSchoolId?:number,Stloc?:string,InstrumentId?:number,Sku?:string,Desc?:string,RateId?:number,Rate?:Rate,AccessoryIdList?:number[],AccessoryList?:Accessory[],FormInputList?:FormInput[],CcInfo?:CcInfo,CustomerInfo?:CustomerInfo,CusAcct?:number,Cat?:number,Sub?:number,ReturnTopic?:boolean,StatusId?:number,CardTerminalId?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description ID of the teacher to associate the contract with. */
    TeacherId;
    /**
     * @type {string}
     * @description Used to associate the contract with a school by school name. */
    SchoolName;
    /**
     * @type {?number}
     * @description Used to associate the contract with a school by the AIM School ID */
    AIMSchoolId;
    /**
     * @type {string}
     * @description Used to associate the contract with a location by location code. */
    Stloc;
    /**
     * @type {?number}
     * @description ID of the instrument to associate the contract with. */
    InstrumentId;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Desc;
    /**
     * @type {?number}
     * @description The ID from the C2BGradeGeneric object */
    RateId;
    /** @type {Rate} */
    Rate;
    /** @type {number[]} */
    AccessoryIdList;
    /** @type {Accessory[]} */
    AccessoryList;
    /** @type {FormInput[]} */
    FormInputList;
    /** @type {CcInfo} */
    CcInfo;
    /** @type {CustomerInfo} */
    CustomerInfo;
    /** @type {?number} */
    CusAcct;
    /** @type {?number} */
    Cat;
    /** @type {?number} */
    Sub;
    /** @type {?boolean} */
    ReturnTopic;
    /** @type {?number} */
    StatusId;
    /** @type {string} */
    CardTerminalId;
}

JavaScript C2BPostContractRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + 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"}}