AIM Web Services

<back to all web services

DeliveryTicketsRequest

DeliveryTickets
Requires active-e 3rd Party E-Commerce or active-e Vortx E-Commerce.

The following routes are available for this service:
GET/api/DeliveryTickets
DeliveryTicketsRequest Parameters:
NameParameterData TypeRequiredDescription
DateFromqueryDateTime?No
DateToqueryDateTime?No
DistrictquerystringNo
SchoolquerystringNo
LocationIdquerylong?No
TicketTypequerystringYesType of Ticket. Valid types are Service Ticket, Sales Invoice, Layaway, Loaner, Short Term Rental, Contract, Delayed Delivery, and Approval
EmployeeLanIdquerystringNo
DeliveryEmployeeLanIdquerystringNo
RefNumberquerystringNo
IncludeItemsqueryboolNo
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNoThe Login Token return by the Security API. Required for secured calls.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyHeaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenHeaderstringYesThe OAuthToken token return by AeServices30
DeviceIdHeaderstringNoThe Device ID of the Mobile Device. Not used for non-mobile devices.
AppIdHeaderstringYesAn identifier for your integration
DeliveryTicketsResponse Parameters:
NameParameterData TypeRequiredDescription
TicketsformList<DeliveryTicket>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
DeliveryTicket Parameters:
NameParameterData TypeRequiredDescription
RefNumberformstringNo
DateformDateTimeNo
AccountNumberformintNo
NameformstringNo
AddressformstringNo
Address2formstringNo
CityformstringNo
StateformstringNo
ZipCodeformstringNo
StudentformstringNo
ContactformstringNo
DeliveredformboolNo
DistrictformstringNo
SchoolformstringNo
DeliveryEmployeeformstringNo
TimeFrameformstringNo
CreatedDateformDateTimeNo
DependentAttributesformList<DependentAttribute>No
TicketTypeformstringNo
HasImagesformboolNo
HasSignatureformboolNo
Base64SignatureformstringNo
NotesformstringNo
ImagesformList<Base64Image>No
DeliveryItemsformList<DeliveryItem>No
DependentAttribute Parameters:
NameParameterData TypeRequiredDescription
AttributeformstringNo
AttributeValueformstringNo
Base64Image Parameters:
NameParameterData TypeRequiredDescription
DataformstringNo
FileNameformstringNo
DeliveryItem Parameters:
NameParameterData TypeRequiredDescription
QuantityformdecimalNo
ItemformstringNo
DescriptionformstringNo

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/DeliveryTickets HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Tickets":[{"RefNumber":"String","AccountNumber":0,"Name":"String","Address":"String","Address2":"String","City":"String","State":"String","ZipCode":"String","Student":"String","Contact":"String","Delivered":false,"District":"String","School":"String","DeliveryEmployee":"String","TimeFrame":"String","DependentAttributes":[{"Attribute":"String","AttributeValue":"String"}],"TicketType":"String","HasImages":false,"HasSignature":false,"Base64Signature":"String","Notes":"String","Images":[{"Data":"String","FileName":"String"}],"DeliveryItems":[{"Quantity":0,"Item":"String","Description":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}