| 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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<C2BGetUnfinishedContractsResponse 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>
<Topic>String</Topic>
<UnfinishedContracts>
<C2BGetUnfinishedContractsResponse.UnfinishedContract>
<Accessories>
<C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
<Category>0</Category>
<Delivered>false</Delivered>
<Description>String</Description>
<Id>0</Id>
<Price>0</Price>
<Sku>String</Sku>
<Type>String</Type>
</C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
</Accessories>
<Address>String</Address>
<Address2>String</Address2>
<City>String</City>
<ContractCreated>false</ContractCreated>
<Country>String</Country>
<CustomerAcct>0</CustomerAcct>
<CustomerName>String</CustomerName>
<DateTime>0001-01-01T00:00:00</DateTime>
<DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
<District>String</District>
<DownLease>0</DownLease>
<DownMaint>0</DownMaint>
<DownPay>0</DownPay>
<DownTotal>0</DownTotal>
<Email>String</Email>
<FirstDue>0001-01-01T00:00:00</FirstDue>
<Instrument>String</Instrument>
<InstrumentGrade>String</InstrumentGrade>
<InvoiceCreated>false</InvoiceCreated>
<Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
<d4p1:Active>false</d4p1:Active>
<d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
<d4p1:Desc>String</d4p1:Desc>
<d4p1:Id>0</d4p1:Id>
<d4p1:InStorePickup>String</d4p1:InStorePickup>
<d4p1:Latitude>0</d4p1:Latitude>
<d4p1:Longitude>0</d4p1:Longitude>
<d4p1:Region>String</d4p1:Region>
<d4p1:ShortDesc>String</d4p1:ShortDesc>
</Location>
<LockedBy>String</LockedBy>
<MonthlyLease>0</MonthlyLease>
<MonthlyMaint>0</MonthlyMaint>
<MonthlyPay>0</MonthlyPay>
<Notes>String</Notes>
<Phone>String</Phone>
<Ref>String</Ref>
<Salesperson>String</Salesperson>
<School>String</School>
<Serial>String</Serial>
<State>String</State>
<Status>String</Status>
<StudentName>String</StudentName>
<Teacher>String</Teacher>
<WebNotes>String</WebNotes>
<Zip>String</Zip>
</C2BGetUnfinishedContractsResponse.UnfinishedContract>
</UnfinishedContracts>
</C2BGetUnfinishedContractsResponse>