POST apimobileoauth/mobile/mobileservicejourneysummary

Get a journey summary for a collection of services

Request Information

URI Parameters

None.

Body Parameters

A MobileServiceJourneySummaryRequest

OAuthMobileServiceJourneySummaryRequest
NameDescriptionTypeAdditional information
ServiceIDs

A list of service ids you require journey summaries for

Collection of unsigned integer

None.

StartDate

The start date being queried

date

None.

EndDate

The end date being queried

date

None.

Request Formats

application/json, text/json

Sample:
{
  "ServiceIDs": [
    1,
    2
  ],
  "StartDate": "2025-04-27T16:50:12.7847469+00:00",
  "EndDate": "2025-04-27T16:50:12.7847469+00:00"
}

application/xml, text/xml

Sample:
<OAuthMobileServiceJourneySummaryRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceIDs>
    <unsignedLong>1</unsignedLong>
    <unsignedLong>2</unsignedLong>
  </ServiceIDs>
  <StartDate>2025-04-27T16:50:12.7847469+00:00</StartDate>
  <EndDate>2025-04-27T16:50:12.7847469+00:00</EndDate>
</OAuthMobileServiceJourneySummaryRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A collection of MobileServiceJourneySummaryResponse

Collection of MobileServiceJourneySummaryResponse
NameDescriptionTypeAdditional 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>