GET api/mobile/mobileservicejourneysummary?userID={userID}&token={token}&serviceIDs={serviceIDs}&startDate={startDate}&endDate={endDate}
Get a journey summary for a collection of services
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
userID |
The token returned after login used for authentication |
unsigned integer |
Required |
token |
The token returned after login used for authentication |
string |
Required |
serviceIDs |
A list of service ids you require journey summaries for |
string |
Required |
startDate |
The start date being queried yyyyMMddHHmmss |
string |
Required |
endDate |
The end date being queried yyyyMMddHHmmss |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
A collection of MobileServiceJourneySummaryResponse
Collection of MobileServiceJourneySummaryResponseName | Description | Type | Additional information |
---|---|---|---|
ServiceID |
The service id |
unsigned integer |
None. |
Duration |
The total duration in seconds |
integer |
None. |
IdleDuration |
The idle duration in seconds |
integer |
None. |
Distance |
The total distance in meters |
integer |
None. |
JourneyCount |
The total journey count |
integer |
None. |
SpeedingEventCount |
The number of speeding events |
integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "ServiceID": 1, "Duration": 2, "IdleDuration": 3, "Distance": 4, "JourneyCount": 5, "SpeedingEventCount": 6 }, { "ServiceID": 1, "Duration": 2, "IdleDuration": 3, "Distance": 4, "JourneyCount": 5, "SpeedingEventCount": 6 } ]
application/xml, text/xml
Sample:
<ArrayOfMobileServiceJourneySummaryResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <MobileServiceJourneySummaryResponse> <ServiceID>1</ServiceID> <Duration>2</Duration> <IdleDuration>3</IdleDuration> <Distance>4</Distance> <JourneyCount>5</JourneyCount> <SpeedingEventCount>6</SpeedingEventCount> </MobileServiceJourneySummaryResponse> <MobileServiceJourneySummaryResponse> <ServiceID>1</ServiceID> <Duration>2</Duration> <IdleDuration>3</IdleDuration> <Distance>4</Distance> <JourneyCount>5</JourneyCount> <SpeedingEventCount>6</SpeedingEventCount> </MobileServiceJourneySummaryResponse> </ArrayOfMobileServiceJourneySummaryResponse>