GET apioauth/matrixv2/services/{serviceId}/odometer

Get the odometer of a service

Request Information

URI Parameters

NameDescriptionTypeAdditional information
serviceId

The id of the service to query

unsigned integer

Required

Body Parameters

None.

Response Information

Resource Description

A ServiceOdometerResponse

ServiceOdometerResponse
NameDescriptionTypeAdditional information
ServiceId

The id of the service

integer

None.

Distance

The distance driven in metres

integer

None.

Duration

The duration of driving in seconds

integer

None.

InputOdometers

A collection of input odometers

Collection of InputOdometer

None.

LastUpdated

When the distance and duration were last updated in UTC

date

None.

Links

Any links to other entities

Collection of Link

None.

Response Formats

application/json, text/json

Sample:
{
  "ServiceId": 1,
  "Distance": 2,
  "Duration": 3,
  "InputOdometers": [
    {
      "InputNumber": 1,
      "Distance": 2,
      "Duration": 3,
      "Description": "sample string 4"
    },
    {
      "InputNumber": 1,
      "Distance": 2,
      "Duration": 3,
      "Description": "sample string 4"
    }
  ],
  "LastUpdated": "2025-04-27T16:11:08.4975997+00:00",
  "Links": [
    {
      "Href": "sample string 1",
      "Rel": "sample string 2"
    },
    {
      "Href": "sample string 1",
      "Rel": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<ServiceOdometerResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceId>1</ServiceId>
  <Distance>2</Distance>
  <Duration>3</Duration>
  <InputOdometers>
    <InputOdometer>
      <InputNumber>1</InputNumber>
      <Distance>2</Distance>
      <Duration>3</Duration>
      <Description>sample string 4</Description>
    </InputOdometer>
    <InputOdometer>
      <InputNumber>1</InputNumber>
      <Distance>2</Distance>
      <Duration>3</Duration>
      <Description>sample string 4</Description>
    </InputOdometer>
  </InputOdometers>
  <LastUpdated>2025-04-27T16:11:08.4975997+00:00</LastUpdated>
  <Links>
    <Link>
      <Href>sample string 1</Href>
      <Rel>sample string 2</Rel>
    </Link>
    <Link>
      <Href>sample string 1</Href>
      <Rel>sample string 2</Rel>
    </Link>
  </Links>
</ServiceOdometerResponse>