AIM Web Services

<back to all web services

DeliveryTicketsPostRequest

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

The following routes are available for this service:
POST/api/DeliveryTickets
DeliveryTicketsPostRequest Parameters:
NameParameterData TypeRequiredDescription
DeliveryTicketsbodyList<DeliveryTicketItem>No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
DeliveryTicketItem Parameters:
NameParameterData TypeRequiredDescription
RefNumberformstringNo
DeliveredformboolNo
ImagesformList<Base64Image>No
Base64SignatureformstringNo
ImagesToDeleteformList<string>No
NotesformstringNo
Base64Image Parameters:
NameParameterData TypeRequiredDescription
DataformstringNo
FileNameformstringNo
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
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.

POST /api/DeliveryTickets HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"DeliveryTickets":[{"RefNumber":"String","Delivered":false,"Images":[{"Data":"String","FileName":"String"}],"Base64Signature":"String","ImagesToDelete":["String"],"Notes":"String"}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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