GetRouteDetails
Contents
The GetRouteDetails
API returns all of the details about a route such as Actuals, GPS Points, Line Items, Orders, Planned Data, Violations, and more. There are three separate calls that you can make to get route details:
GetRouteDetailByDateRange
GetRouteDetailByModifiedDate
GetRouteDetailByPlannedStartDate
Each call uses the same request. However, ByModifiedDate
and ByPlannedStartDate
do not use the routeDetailSearchByOptionField
and default to search by modified date and planned start date, respectively. You can also filter the details returned in your results by setting RouteDetailReturnOptionsFilters
.
Schema
<soapenv:Envelope xmlns:soapenv= "http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem= "http://tempuri.org/" xmlns:app= "http://schemas.datacontract.org/2004/07/Appian.DRTrack.Entity.Schema.WebService" xmlns:arr= "http://schemas.microsoft.com/2003/10/Serialization/Arrays" >
<soapenv:Header/>
<soapenv:Body>
<tem:GetRouteDetailByDateRange>
<!--Optional:-->
<tem:auth>
<!--#### string-->
<app:authenticationTokenField> dev1-appi-20160617175057-XXIB8E</app:authenticationTokenField>
</tem:auth>
<!--Optional:-->
<tem:requestEnvelope>
<!--#### string-->
<app:branchIDField> BAKERY TEST OKC</app:branchIDField>
<!--#### dateTime-->
<app:fromDateField> 2017-06-16T00:00:00</app:fromDateField>
<app:routeDetailReturnOptionsField>
<app:filtersField>
<app:dispatchIDListField>
<!--Zero or more repetitions:-->
<!--#### string-->
<!--<arr:string>temperat iras</arr:string>-->
</app:dispatchIDListField>
<!--#### boolean-->
<app:populateActualsDataField> true</app:populateActualsDataField>
<!--#### boolean-->
<app:populateGPSPointsField> true</app:populateGPSPointsField>
<!--#### boolean-->
<app:populateLineItemField> true</app:populateLineItemField>
<!--#### boolean-->
<app:populateLineItemFormsField> true</app:populateLineItemFormsField>
<!--#### boolean-->
<app:populateOrderField> true</app:populateOrderField>
<!--#### boolean-->
<app:populateOrderFormsField> true</app:populateOrderFormsField>
<!--#### boolean-->
<app:populatePlannedDataField> true</app:populatePlannedDataField>
<!--#### boolean-->
<app:populateQuantityFieldField> true</app:populateQuantityFieldField>
<!--#### boolean-->
<app:populateRouteFormsField> true</app:populateRouteFormsField>
<!--#### boolean-->
<app:populateStopField> true</app:populateStopField>
<!--#### boolean-->
<app:populateUserFieldField> true</app:populateUserFieldField>
<!--#### boolean-->
<app:populateViolationsField> true</app:populateViolationsField>
<app:routeIDListField>
<!--Zero or more repetitions:-->
<!--#### int-->
<arr:int> 3</arr:int>
</app:routeIDListField>
<!--#### RouteType - enumeration: [AllRoute,NotStarted,InProgress,Completed]-->
<app:routeTypeField> AllRoute</app:routeTypeField>
</app:filtersField>
</app:routeDetailReturnOptionsField>
<!--#### RouteDetailSearchByOptions - enumeration: [PlannedStart,PlannedEnd,DispatchDate,RoutesModifiedByDispatch,RoutesModifiedByDataPosted,AllRoutesModified]-->
<app:routeDetailSearchByOptionsField> PlannedStart</app:routeDetailSearchByOptionsField>
<!--#### dateTime-->
<app:toDateField> 2017-07-20T00:00:00</app:toDateField>
</tem:requestEnvelope>
</tem:GetRouteDetailByDateRange>
</soapenv:Body>
</soapenv:Envelope>
Request Parameters
(Note: Boolean parameter values should be lowercase true
or false
.)
GetRouteDetailByDateRange
Authentication
Name Description Type Required Sample Value
AuthenticationTokenField
Retrieved from WS Call
GetAuthenticationToken
.
string Yes dev1-appi-20160617175057-XXIB8E
RouteDetailRequestEnvelope
Name Description Type Required Sample Value
branchIDField
The branch ID that you want to retrieve the routes from.
string Yes MAIN
fromDateField
The start date/time range of the request.
dateTime Yes 2019-06-07T08:30:00-06:00
routeDetailReturnOptionsField
The types of data to be returned.
RouteDetailReturnOptions
Yes See
RouteDetailReturnOptions
routeDetailSearchByOptionField
The type of date that is searched. See type for options.
RouteDetailSearchByOptions
Yes See
RouteDetailSearchByOptions
toDateField
The end date/time range of the request.
dateTime Yes 2019-06-07T08:30:00-06:00
RouteDetailReturnOptions
RouteDetailReturnOptionsFilters
Name Description Type Required Sample Value
DispatchIDListField
A list of the dispatch IDs to be returned. array of
string Yes 12-OK
populateActualsDataField
true or false. Populates the Route Start/End Fields.
boolean Yes true
populateGPSPointsField
true or false. Populates Lat/Long fields.
boolean Yes true
populateLineItemField
true or false. Populates Line Item fields.
boolean Yes true
populateLineItemFormsField
true or false. Populates Line Item Forms fields.
boolean Yes true
populateOrderField
true or false. Populates Order fields.
boolean Yes true
populateOrderFormsField
true or false. Populates Order Form fields.
boolean Yes true
populatePlannedDataField
true or false. Populates Planned Data field.
boolean Yes true
populateQuantityFieldField
true or false. Populates the quantity fields.
boolean Yes true
populateRouteFormsField
true or false. Populates the route forms.
boolean Yes true
populateStopField
true or false. Populates the stop fields.
boolean Yes true
populateUserFieldField
true or false. Populates the user fields.
boolean Yes true
populateViolationsField
true or false. Populates the violations fields.
boolean Yes true
routeIDListField
A list of the route numbers to be returned. array of
int Yes 5
routeTypeField
The Type of Routes to be returned. See table for options to enter.
RouteType
Yes InProgress
RouteType
Name Description
AllRoute
All Routes.
NotStarted
Routes that have not started.
InProgress
Routes that are currently in progress.
Completed
Routes that have been completed.
RouteDetailSearchByOptions
Name Description
PlannedStart
Planned route start time.
PlannedEnd
Planned route end time.
DispatchDate
Planned route dispatch date.
RouteModifiedByDispatchDate
Routes that have been modified by dispatch date.
RoutesModifiedByDataPosted
Routes that have been modified by modified date.
AllRoutesModified
All routes with recorded modification.
Response Parameters
GetRouteDetailByDateRangeResult
Name Description Type Sample Value
fromDateField
The beginning date of the pagination.
dateTime 2019-06-07T08:30:00-06:00
toDateField
The end date of the pagination.
dateTime 2019-06-07T08:30:00-06:00
ResponseStatus
ArrayOfResponseStatusError
ResponseStatusError
Name Description Type Sample Value
codeField
The code number of the error.
int 500
messageField
The message of the error that occurred.
string Server return an error
ArrayOfResponseStatusWarning
ResponseStatusWarning
Name Description Type Sample Value
codeField
The code number of the warning.
int 100
messageField
The message of the warning that occurred.
string To many results returned. Please make sure to use Pagination.
ArrayofRouteDetailResponseEnvelopeRouteDetail
RouteDetailResponseEnvelopeRouteDetail
RouteActualDetailType
Name Description Type Sample Value
delayField
string 356
deviceIDField
The ID/name of the device.
string Phone100
driverIDField
The ID of the driver.
string John123
driverNameField
The name of the driver.
string John Doe
endOdometerField
The ending odometer of the route.
int 75309
endTimeField
The ending time of the route.
dateTime 2019-06-06T21:06:16Z
gPSPointListField
The list of GPS points on the route.
ArrayOfGPSPointDetailType
See
ArrayOfGPSPointDetailType
lastGPSTransmissionTimeField
The time of the last GPS transmission.
dateTime 2019-06-06T21:04:50Z
routeFormsListField
The forms filled out on the route.
ArrayOfRouteFormsDetailType
See
ArrayOfRouteFormsDetailType
routeIDField
The internal ID of the route.
int 321
startOdometerField
The starting odometer of the route.
int 120456
startTimeField
The starting time of the route.
dateTime 2019-06-06T12:33:56Z
stopField
The details of the stop’s actuals.
ArrayOfStopActualDetailType
See
ArrayOfStopActualDetailType
vehicleIDField
The ID of the vehicle being used.
string Truck123
RoutePlanDetailType
Name Description Type Sample Value
delayTimeField
int 356
dispatchDateField
The dispatch date of the route.
dateTime 2019-06-06T05:00:00Z
dispatchIDField
The dispatchID of the route.
string 1-OKC
endTimeField
The planned end time of the route.
dateTime 2019-06-06T19:29:10Z
lastDataPostedField
dateTime 2019-06-16T21:32:49.15
lastDateModifiedField
The date the route was last modified.
dateTime 2019-06-16T21:32:49.15
loadDateTime
The time the route was loaded.
dateTime 2019-06-06T19:29:10Z
routeIDField
The internal ID of the route.
dateTime 380
rtNumberField
The number of the route.
int 1
startTime
The planned start time of the route.
dateTime 2019-06-06T19:29:10Z
stopField
An array of all the stops on the route.
ArrayOfStopPlanDetailType
See
ArrayOfStopPlanDetailType
totalDistanceCostField
The estimated total cost of the route.
float 354.78
totalDistanceField
The estimated total distance of the route.
float 75.8
totalDriveHrsField
The estimated drive time of the route.
string PT4H14S
totalStopsField
The number of stops on the route.
int 12
totalWorkHrsField
The estimated work time of the route.
string PT6H55M14S
ArrayOfGPSPointDetailType
ArrayOfStopActualDetailType
ArrayOfStopPlanDetailType
GPSPointDetailType
Name Description Type Sample Value
coordinatesField
The header of the GPS coordinates.
Coordinates
See
Coordinates
GPSTimeField
The time of the GPS point.
dateTime 2019-06-06T19:29:10Z
headingField
The direction in which the GPS point was heading.
int 180
odometerField
The odometer of the vehicle at the time of the GPS point.
float 123456
satellitesField
No longer in use.
int Not in use.
speedField
The speed of the vehicle at the time of the GPS point.
int 65
Name Description Type Sample Value
createdDateTimeField
The dateTime the form value was entered.
dateTime 2019-06-06T19:29:10Z
fieldNameField
The name of the field on the form.
string DriverID
formNameField
The name of the form.
string Driver Login
formValueField
The value of the field listed in fieldNameField.
string Driver1
StopActualDetailType
Name Description Type Sample Value
actualStopIDField
The ID given to the stop actual.
int 283
coordinatesField
The header of the GPS coordinates.
Coordinates
See
Coordinates
delayTimeField
The time the vehicle was delayed.
string 26
durationField
The time the vehicle was at the stop.
string 33
endTimeField
The end time the vehicle was at the stop.
dateTime 2019-06-16T22:10:23Z
inprogressField
If the truck is currently at the stop.
boolean false
legField
The leg that the truck is on.
int 1
odometerField
The mileage on the truck at the stop.
float 123456
orderField
The order detail actuals.
ArrayOfOrderDetailActualDetailType
See
ArrayOfOrderDetailActualDetailType
sequenceField
The sequence of the actual.
int 12
startTimeField
The start time the vehicle was at the stop.
dateTime 2019-06-16T21:36:26Z
stopIDField
The ID of the stop that actual stop is tied to.
int 153
Coordinates
Name Description Type Sample Value
latitudeField
The latitude of the GPS point.
float 35.45658
longitudeField
The longitude of the GPS point.
float -97.59814
ArrayOfOrderDetailActualDetailType
OrderDetailActualDetailType
Name Description Type Sample Value
accountKeyIDField
The internal issued account key ID.
int 45
lineItemField
The line item detail actuals.
ArrayOfLineItemDetailActualType
See
ArrayOfLineItemDetailActualType
OrderIDField
The order ID.
string PO123
orderKeyIDField
The internal key ID of the order.
int 1534
shipToKeyIDField
The ship to key ID of the order.
int 1
ArrayOfLineItemDetailActualType
LineItemDetailActualType
Name Description Type Sample Value
actualField
The line item actuals.
LineItemActualType
See
LineItemActualType
lineItemIDField
The ID of the line item on the order.
string SKU456
lineItemKeyIDField
The internal Key ID of the line item.
int 2
LineItemActualType
ArrayOfQuantityFieldListQuantityField
ArrayOfPhotoResource
ArrayOfSignatureResource
QuantityFieldListQuantityField
Name Description Type Sample Value
nameField
The name of the quantity field.
string Cube
unloadRateField
The unload rate of the quantity.
float 1.65
valueField
The value of the quantity.
float 1.65
Name Description Type Sample Value
nameField
The name field of the form item.
string Item_Condition
valueField
A string array of the values. array of
string
PhotoResource
Name Description Type Sample Value
createdField
The time the photo was created/taken.
dateTime 2019-06-16T22:18:24Z
gUIDField
An ID given to the photo.
string 2d82903b-5e4c-4988-9949-4592a941396e
URLField
A URL to view the photo.
string http://resource.appiangps.com/api/Resources/
DescriptionField
A description of the photo.
string
mimeField
The type of photo it is.
string image/png
subjectField
The subject of the photo.
string POD
SignatureResource
Name Description Type Sample Value
createdField
The time the signature was created/taken.
dateTime 2019-06-16T22:18:24Z
gUIDField
An ID given to the signature.
string 2d82903b-5e4c-4988-9949-4592a941396e
URLField
A URL to view the signature.
string http://resource.appiangps.com/api/Resources/
DescriptionField
A description of the signature.
string
mimeField
The type of signature it is.
string image/png
subjectField
The subject of the signature.
string POD
StopPlanDetailType
Name Description Type Sample Value
accountIDField
The ID given to the account.
string A1
actualStopIDField
The ID of the stop actual.
int 684
breakTimeField
The time of the break after this planned stop.
string 0
customTimeWindowField
A time window just for this stop and not the account.
ArrayOfTimeWindowType
See
ArrayOfTimeWindowType
delayTimeField
string 25
distanceField
The distance (in miles) to travel to get to this stop.
float 6
endTimeField
The planned end time.
dateTime 2019-06-16T22:10:00Z
estimateEndTimeField
The estimated end time calculated after actuals.
dateTime 2019-06-16T22:10:00Z
estimateStartTimeField
The estimated start time calculated after actuals.
dateTime 2019-06-16T22:10:00Z
fixedTimeField
Fixed time at the stop.
string 10
hasTimeActualField
boolean false
hasTimeViolationField
true, if the stop has a time violation.
boolean false
isTerminalField
true, if this stop is the terminal.
boolean false
layoverTimeField
Time of a layover after this stop.
string 0
legField
The leg of the route this stop is on.
int 1
orderField
The planned order detail.
ArrayOfOrderDetailPlanDetailType
See
ArrayOfOrderDetailPlanDetailType
sequenceField
The sequence number of the stop.
int 2
shipToAddressField
The ship to address.
AddressType
See
AddressType
startTimeField
The planned start time.
dateTime 2019-06-16T22:10:00Z
stopIDField
The internal ID given to the stop.
int 1234
violationsField
The violations on the stop. array Of string]
waitTimeField
The wait time before delivering this stop.
string 5
ArrayOfTimeWindowType
ArrayOfOrderDetailPlanDetailType
AddressType
Name Description Type Sample Value
address1Field
The address 1 field.
string 123 Main St.
address2Field
The address 2 field.
string Apt 2
cityField
The city field.
string Oklahoma City
coordinatesField
The coordinates for the ship to address.
Coordinates
See
Coordinates
stateField
The state field of the address.
string Oklahoma
zipCodeField
The zip code of the address
string 73160-1234
TimeWindowType
Name Description Type Sample Value
closeField
The close time of the time window.
dateTime 2019-06-16T08:00:00Z
openField
The open time of the time window.
dateTime 2019-06-16T17:00:00Z
patternField
The pattern of the time window.
string SMTWRFA
OrderDetailPlanDetailType
Name Description Type Sample Value
accountIDField
The ID given to the account.
string A1
accountKeyIDField
The internal issued account key ID.
int 356
eqCodeField
The equipment code for the order.
string LG
lineItemField
The line items for the order.
ArrayOfLineItemDetailPlanType
See
ArrayOfLineItemDetailPlanType
orderIDField
The ID given to the order.
string SO123
orderKeyIDField
The internal ID given to the order.
int 1234
orderStatusField
The current status of the order. See type for returned options. See
OrderStatusType
ERPToDRTrack
shipToKeyIDField
The key ID for the ship to address.
int 2
OrderStatusType
Name Sample Value
ERPToDRTrack
The order was imported into DRTrack.
DRTrackToDirectRoute
The order has been sent to Direct Route.
DirectRouteToDRTrack
The order was imported to DRTrack from DirectRoute.
ExportedOrder
The order has been exported.
Unknown
Unknown.
ArrayOfLineItemDetailPlanType
LineItemDetailPlanType
Name Description Type Sample Value
lineItemIDField The line item ID given to DRTrack.
string 001
lineItemKeyIDField The internal key given to the line item.
int 1546
planField The line item planned quantities and user fields.
LineItemPlanType
See
LineItemPlanType
LineItemPlanType
ArrayOfUserFieldListUserField
UserFieldListUserField
Name Description Type Sample Value
nameField
The name of the user field.
string Comments
valueField
The value of the user field.
string Enter comment here.