AIM Web Services

<back to all web services

EditDeliveryTicketRequest

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

The following routes are available for this service:
POST/api/EditDeliveryTicket
EditDeliveryTicketRequest Parameters:
NameParameterData TypeRequiredDescription
RefNumberbodystringNo
NotesbodystringNo
AppendNotesbodyboolNo
NewDeliveryLanIdbodystringNo
NewDeliveryDatebodyDateTime?No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo

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/EditDeliveryTicket HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RefNumber":"String","Notes":"String","AppendNotes":false,"NewDeliveryLanId":"String","NewDeliveryDate":"0001-01-01T00:00:00.0000000","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}