AIM Web Services

<back to all web services

ServiceTicketFullDetailsRequest

ServiceTicketFullDetails
Requires active-e Service Tickets Service

The following routes are available for this service:
GET/api/ServiceTicketFullDetails
ServiceTicketFullDetailsRequest Parameters:
NameParameterData TypeRequiredDescription
Acctqueryint?No
RefNumberquerystringNo
ChangedDatequeryDateTime?No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
ServiceTicketFullDetailsResponse Parameters:
NameParameterData TypeRequiredDescription
TicketsformList<TicketInfo>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
TicketInfo Parameters:
NameParameterData TypeRequiredDescription
TermsformintNo
PoNumberformstringNo
ReturnAuthorizationNumberformstringNo
StatusformstringNo
ApprovedAmountformdecimalNo
TotalDueformdecimalNo
SubtotalformdecimalNo
Tax1formdecimalNo
Tax2formdecimalNo
ApprovedDateformDateTimeNo
BilledDateformDateTimeNo
ContactformstringNo
CategoryformintNo
ServicesformList<ServiceInfo>No
CategoryDescriptionformstringNo
SubCategoryformintNo
SubCategoryDescriptionformstringNo
ItemformstringNo
ItemDescriptionformstringNo
ManufacturerformstringNo
NotesformstringNo
TimestampformDateTimeNo
SoldToCustomerAcctformintNo
BillToCustomerAcctformintNo
ModelformstringNo
StLocformstringNo
TaxLocformstringNo
RefNumberformstringNo
MasterNumberformstringNo
InvoicedformboolNo
DepositsformList<DepositInfo>No
SoldToCustomerNameformstringNo
BillToCustomerNameformstringNo
ShipToNameformstringNo
ShipToIdformlong?No
ServiceInfo Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PartsformList<PartInfo>No
DescriptionformstringNo
QuantityformdecimalNo
RateformdecimalNo
DiscountformdecimalNo
TotalformdecimalNo
TimeformdecimalNo
CompletedformboolNo
CompletedDateformDateTimeNo
TechnicianformstringNo
NotesformstringNo
CategoryformintNo
CategoryDescriptionformstringNo
TimerActiveformboolNo
TimerStartTimeformDateTime?No
PartInfo Parameters:
NameParameterData TypeRequiredDescription
DescriptionformstringNo
QuantityformdecimalNo
PriceformdecimalNo
DiscountformdecimalNo
TotalformdecimalNo
NotesformstringNo
CategoryformintNo
CategoryDescriptionformstringNo
SkuformstringNo
DepositInfo Parameters:
NameParameterData TypeRequiredDescription
OriginalAmountformdecimalNo
AmountformdecimalNo
RefNumberformstringNo

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/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"}}