AIM Web Services

<back to all web services

C2BGetUnfinishedContractsRequest

C2BGetUnfinishedContracts
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/C2BGetUnfinishedContracts
"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 LocationInfo {
    /** @param {{Id?:number,Desc?:string,ShortDesc?:string,Region?:string,Latitude?:number,Longitude?:number,InStorePickup?:string,Active?:boolean,CashSaleAcct?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Desc;
    /** @type {string} */
    ShortDesc;
    /** @type {string} */
    Region;
    /** @type {number} */
    Latitude;
    /** @type {number} */
    Longitude;
    /** @type {string} */
    InStorePickup;
    /** @type {boolean} */
    Active;
    /** @type {?number} */
    CashSaleAcct;
}
export class C2BAccessory {
    /** @param {{Id?:number,Description?:string,Price?:number,Type?:string,Sku?:string,Category?:number,Delivered?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Description;
    /** @type {number} */
    Price;
    /** @type {string} */
    Type;
    /** @type {string} */
    Sku;
    /** @type {?number} */
    Category;
    /** @type {boolean} */
    Delivered;
}
export class UnfinishedContract {
    /** @param {{CustomerName?:string,CustomerAcct?:number,StudentName?:string,Ref?:string,DateTime?:string,Location?:LocationInfo,District?:string,School?:string,Teacher?:string,Instrument?:string,Status?:string,Notes?:string,LockedBy?:string,InstrumentGrade?:string,Serial?:string,Salesperson?:string,WebNotes?:string,Email?:string,Phone?:string,DeliveryDate?:string,FirstDue?:string,Accessories?:C2BAccessory[],DownPay?:number,MonthlyPay?:number,DownMaint?:number,MonthlyMaint?:number,DownLease?:number,MonthlyLease?:number,DownTotal?:number,Address?:string,Address2?:string,City?:string,State?:string,Zip?:string,Country?:string,InvoiceCreated?:boolean,ContractCreated?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CustomerName;
    /** @type {number} */
    CustomerAcct;
    /** @type {string} */
    StudentName;
    /** @type {string} */
    Ref;
    /** @type {string} */
    DateTime;
    /** @type {LocationInfo} */
    Location;
    /** @type {string} */
    District;
    /** @type {string} */
    School;
    /** @type {string} */
    Teacher;
    /** @type {string} */
    Instrument;
    /** @type {string} */
    Status;
    /** @type {string} */
    Notes;
    /** @type {string} */
    LockedBy;
    /** @type {string} */
    InstrumentGrade;
    /** @type {string} */
    Serial;
    /** @type {string} */
    Salesperson;
    /** @type {string} */
    WebNotes;
    /** @type {string} */
    Email;
    /** @type {string} */
    Phone;
    /** @type {?string} */
    DeliveryDate;
    /** @type {?string} */
    FirstDue;
    /** @type {C2BAccessory[]} */
    Accessories;
    /** @type {number} */
    DownPay;
    /** @type {number} */
    MonthlyPay;
    /** @type {number} */
    DownMaint;
    /** @type {number} */
    MonthlyMaint;
    /** @type {number} */
    DownLease;
    /** @type {number} */
    MonthlyLease;
    /** @type {number} */
    DownTotal;
    /** @type {string} */
    Address;
    /** @type {string} */
    Address2;
    /** @type {string} */
    City;
    /** @type {string} */
    State;
    /** @type {string} */
    Zip;
    /** @type {string} */
    Country;
    /** @type {boolean} */
    InvoiceCreated;
    /** @type {boolean} */
    ContractCreated;
}
export class C2BGetUnfinishedContractsResponse extends BaseResponse {
    /** @param {{UnfinishedContracts?:UnfinishedContract[],Topic?:string,BaseUrl?:string,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {UnfinishedContract[]} */
    UnfinishedContracts;
    /** @type {string} */
    Topic;
    /** @type {string} */
    BaseUrl;
}
export class C2BGetUnfinishedContractsRequest extends BaseSecureRequest {
    /** @param {{Type?:string,StartOffset?:number,RecordCount?:number,SearchStr?:string,IncludeContractsEnteredByOtherUsers?:boolean,DistrictId?:number,SchoolId?:number,TeacherId?:number,DeliveryDesc?:string,Status?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Type;
    /** @type {?number} */
    StartOffset;
    /** @type {?number} */
    RecordCount;
    /** @type {string} */
    SearchStr;
    /** @type {boolean} */
    IncludeContractsEnteredByOtherUsers;
    /** @type {?number} */
    DistrictId;
    /** @type {?number} */
    SchoolId;
    /** @type {?number} */
    TeacherId;
    /** @type {string} */
    DeliveryDesc;
    /** @type {string} */
    Status;
}

JavaScript C2BGetUnfinishedContractsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/C2BGetUnfinishedContracts HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"UnfinishedContracts":[{"CustomerName":"String","CustomerAcct":0,"StudentName":"String","Ref":"String","Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"District":"String","School":"String","Teacher":"String","Instrument":"String","Status":"String","Notes":"String","LockedBy":"String","InstrumentGrade":"String","Serial":"String","Salesperson":"String","WebNotes":"String","Email":"String","Phone":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","FirstDue":"0001-01-01T00:00:00.0000000","Accessories":[{"Id":0,"Description":"String","Price":0,"Type":"String","Sku":"String","Category":0,"Delivered":false}],"DownPay":0,"MonthlyPay":0,"DownMaint":0,"MonthlyMaint":0,"DownLease":0,"MonthlyLease":0,"DownTotal":0,"Address":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","InvoiceCreated":false,"ContractCreated":false}],"Topic":"String","BaseUrl":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}