POST apimobileoauth/mobile/mobileservicescore

Get scores for services

Request Information

URI Parameters

None.

Body Parameters

A OAuthMobileServiceScoreRequest

OAuthMobileServiceScoreRequest
NameDescriptionTypeAdditional information
ServiceIDs

A list of service ids you require score summaries for

Collection of unsigned integer

None.

StartDate

The start date being queried

date

None.

EndDate

The end date being queried

date

None.

ScoreType

The type of score being queried

ScoreType

None.

ScorePeriod

The score period being queried

ScorePeriod

None.

GroupID

The group id the services are stored in so the correct score weightings can be used.

unsigned integer

None.

Request Formats

application/json, text/json

Sample:
{
  "ServiceIDs": [
    1,
    2
  ],
  "StartDate": "2025-04-27T16:50:14.7691729+00:00",
  "EndDate": "2025-04-27T16:50:14.7691729+00:00",
  "ScoreType": 0,
  "ScorePeriod": 0,
  "GroupID": 3
}

application/xml, text/xml

Sample:
<OAuthMobileServiceScoreRequest 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:14.7691729+00:00</StartDate>
  <EndDate>2025-04-27T16:50:14.7691729+00:00</EndDate>
  <ScoreType>fuel</ScoreType>
  <ScorePeriod>journey</ScorePeriod>
  <GroupID>3</GroupID>
</OAuthMobileServiceScoreRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A collection of OAuthMobileServiceScoreResponse

Collection of OAuthMobileServiceScoreResponse
NameDescriptionTypeAdditional information
ServiceId

The service id which made the score

unsigned integer

None.

Duration

The score duration in seconds

integer

None.

Distance

The score distance in metres

integer

None.

UrbanScore

The urban score

integer

None.

NightScore

The night score

integer

None.

AccelerationScore

The acceleration Score

integer

None.

DecelerationScore

The deceleration Score

integer

None.

SpeedingScore

The speeding score

integer

None.

OverallScore

The overall score

integer

None.

StartDate

The score period start time

date

None.

EndDate

The score period end time

date

None.

JourneyCount

The total journey count

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ServiceId": 1,
    "Duration": 2,
    "Distance": 3,
    "UrbanScore": 4,
    "NightScore": 5,
    "AccelerationScore": 6,
    "DecelerationScore": 7,
    "SpeedingScore": 8,
    "OverallScore": 9,
    "StartDate": "2025-04-27T16:50:14.7691729+00:00",
    "EndDate": "2025-04-27T16:50:14.7691729+00:00",
    "JourneyCount": 12
  },
  {
    "ServiceId": 1,
    "Duration": 2,
    "Distance": 3,
    "UrbanScore": 4,
    "NightScore": 5,
    "AccelerationScore": 6,
    "DecelerationScore": 7,
    "SpeedingScore": 8,
    "OverallScore": 9,
    "StartDate": "2025-04-27T16:50:14.7691729+00:00",
    "EndDate": "2025-04-27T16:50:14.7691729+00:00",
    "JourneyCount": 12
  }
]

application/xml, text/xml

Sample:
<ArrayOfOAuthMobileServiceScoreResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OAuthMobileServiceScoreResponse>
    <ServiceId>1</ServiceId>
    <Duration>2</Duration>
    <Distance>3</Distance>
    <UrbanScore>4</UrbanScore>
    <NightScore>5</NightScore>
    <AccelerationScore>6</AccelerationScore>
    <DecelerationScore>7</DecelerationScore>
    <SpeedingScore>8</SpeedingScore>
    <OverallScore>9</OverallScore>
    <StartDate>2025-04-27T16:50:14.7691729+00:00</StartDate>
    <EndDate>2025-04-27T16:50:14.7691729+00:00</EndDate>
    <JourneyCount>12</JourneyCount>
  </OAuthMobileServiceScoreResponse>
  <OAuthMobileServiceScoreResponse>
    <ServiceId>1</ServiceId>
    <Duration>2</Duration>
    <Distance>3</Distance>
    <UrbanScore>4</UrbanScore>
    <NightScore>5</NightScore>
    <AccelerationScore>6</AccelerationScore>
    <DecelerationScore>7</DecelerationScore>
    <SpeedingScore>8</SpeedingScore>
    <OverallScore>9</OverallScore>
    <StartDate>2025-04-27T16:50:14.7691729+00:00</StartDate>
    <EndDate>2025-04-27T16:50:14.7691729+00:00</EndDate>
    <JourneyCount>12</JourneyCount>
  </OAuthMobileServiceScoreResponse>
</ArrayOfOAuthMobileServiceScoreResponse>