| GET | /api/ServiceTicketFullDetails |
|---|
"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 PartInfo {
/** @param {{Description?:string,Quantity?:number,Price?:number,Discount?:number,Total?:number,Notes?:string,Category?:number,CategoryDescription?:string,Sku?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Description;
/** @type {number} */
Quantity;
/** @type {number} */
Price;
/** @type {number} */
Discount;
/** @type {number} */
Total;
/** @type {string} */
Notes;
/** @type {number} */
Category;
/** @type {string} */
CategoryDescription;
/** @type {string} */
Sku;
}
export class ServiceInfo {
/** @param {{Id?:number,Parts?:PartInfo[],Description?:string,Quantity?:number,Rate?:number,Discount?:number,Total?:number,Time?:number,Completed?:boolean,CompletedDate?:string,Technician?:string,Notes?:string,Category?:number,CategoryDescription?:string,TimerActive?:boolean,TimerStartTime?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {PartInfo[]} */
Parts;
/** @type {string} */
Description;
/** @type {number} */
Quantity;
/** @type {number} */
Rate;
/** @type {number} */
Discount;
/** @type {number} */
Total;
/** @type {number} */
Time;
/** @type {boolean} */
Completed;
/** @type {string} */
CompletedDate;
/** @type {string} */
Technician;
/** @type {string} */
Notes;
/** @type {number} */
Category;
/** @type {string} */
CategoryDescription;
/** @type {boolean} */
TimerActive;
/** @type {?string} */
TimerStartTime;
}
export class DepositInfo {
/** @param {{OriginalAmount?:number,Amount?:number,RefNumber?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
OriginalAmount;
/** @type {number} */
Amount;
/** @type {string} */
RefNumber;
}
export class TicketInfo {
/** @param {{Terms?:number,PoNumber?:string,ReturnAuthorizationNumber?:string,Status?:string,ApprovedAmount?:number,TotalDue?:number,Subtotal?:number,Tax1?:number,Tax2?:number,ApprovedDate?:string,BilledDate?:string,Contact?:string,Category?:number,Services?:ServiceInfo[],CategoryDescription?:string,SubCategory?:number,SubCategoryDescription?:string,Item?:string,ItemDescription?:string,Manufacturer?:string,Notes?:string,Timestamp?:string,SoldToCustomerAcct?:number,BillToCustomerAcct?:number,Model?:string,StLoc?:string,TaxLoc?:string,RefNumber?:string,MasterNumber?:string,Invoiced?:boolean,Deposits?:DepositInfo[],SoldToCustomerName?:string,BillToCustomerName?:string,ShipToName?:string,ShipToId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Terms;
/** @type {string} */
PoNumber;
/** @type {string} */
ReturnAuthorizationNumber;
/** @type {string} */
Status;
/** @type {number} */
ApprovedAmount;
/** @type {number} */
TotalDue;
/** @type {number} */
Subtotal;
/** @type {number} */
Tax1;
/** @type {number} */
Tax2;
/** @type {string} */
ApprovedDate;
/** @type {string} */
BilledDate;
/** @type {string} */
Contact;
/** @type {number} */
Category;
/** @type {ServiceInfo[]} */
Services;
/** @type {string} */
CategoryDescription;
/** @type {number} */
SubCategory;
/** @type {string} */
SubCategoryDescription;
/** @type {string} */
Item;
/** @type {string} */
ItemDescription;
/** @type {string} */
Manufacturer;
/** @type {string} */
Notes;
/** @type {string} */
Timestamp;
/** @type {number} */
SoldToCustomerAcct;
/** @type {number} */
BillToCustomerAcct;
/** @type {string} */
Model;
/** @type {string} */
StLoc;
/** @type {string} */
TaxLoc;
/** @type {string} */
RefNumber;
/** @type {string} */
MasterNumber;
/** @type {boolean} */
Invoiced;
/** @type {DepositInfo[]} */
Deposits;
/** @type {string} */
SoldToCustomerName;
/** @type {string} */
BillToCustomerName;
/** @type {string} */
ShipToName;
/** @type {?number} */
ShipToId;
}
export class ServiceTicketFullDetailsResponse extends BaseResponse {
/** @param {{Tickets?:TicketInfo[],Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {TicketInfo[]} */
Tickets;
}
export class ServiceTicketFullDetailsRequest extends BaseSecureRequest {
/** @param {{Acct?:number,RefNumber?:string,ChangedDate?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
Acct;
/** @type {string} */
RefNumber;
/** @type {?string} */
ChangedDate;
}
JavaScript ServiceTicketFullDetailsRequest 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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/ServiceTicketFullDetails HTTP/1.1 Host: active-ewebservice.biz Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"Tickets":[{"Terms":0,"PoNumber":"String","ReturnAuthorizationNumber":"String","Status":"String","ApprovedAmount":0,"TotalDue":0,"Subtotal":0,"Tax1":0,"Tax2":0,"Contact":"String","Category":0,"Services":[{"Id":0,"Parts":[{"Description":"String","Quantity":0,"Price":0,"Discount":0,"Total":0,"Notes":"String","Category":0,"CategoryDescription":"String","Sku":"String"}],"Description":"String","Quantity":0,"Rate":0,"Discount":0,"Total":0,"Time":0,"Completed":false,"Technician":"String","Notes":"String","Category":0,"CategoryDescription":"String","TimerActive":false,"TimerStartTime":"0001-01-01T00:00:00.0000000"}],"CategoryDescription":"String","SubCategory":0,"SubCategoryDescription":"String","Item":"String","ItemDescription":"String","Manufacturer":"String","Notes":"String","SoldToCustomerAcct":0,"BillToCustomerAcct":0,"Model":"String","StLoc":"String","TaxLoc":"String","RefNumber":"String","MasterNumber":"String","Invoiced":false,"Deposits":[{"OriginalAmount":0,"Amount":0,"RefNumber":"String"}],"SoldToCustomerName":"String","BillToCustomerName":"String","ShipToName":"String","ShipToId":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}