POST api/public/v2/dispatch
Request Information
URI Parameters
None.
Body Parameters
DriverJobRequestModelName | Description | Type | Additional information |
---|---|---|---|
ApiKey |
Your merchant API key |
globally unique identifier |
Required |
DriverIdentifier |
Driver identifier |
globally unique identifier |
None. |
JobId |
Job Id |
integer |
None. |
JobIdentifier |
Job identifier. This can be used in place of JobId |
globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "apiKey": "66537c20-3895-4b52-9ef4-bb241ba35ca7", "driverIdentifier": "c75b3d98-5f13-4410-a85a-dd26a7b617ee", "jobId": 3, "jobIdentifier": "57b4720f-26bf-4400-985f-3d9036a68a29" }
text/xml
Sample:
<DriverJobRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Swift.DeliveryAPI2"> <ApiKey>66537c20-3895-4b52-9ef4-bb241ba35ca7</ApiKey> <DriverIdentifier>c75b3d98-5f13-4410-a85a-dd26a7b617ee</DriverIdentifier> <JobId>3</JobId> <JobIdentifier>57b4720f-26bf-4400-985f-3d9036a68a29</JobIdentifier> </DriverJobRequestModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
stringResponse Formats
application/json, text/json
Sample:
"sample string 1"
text/xml
Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>