POST api/v4/odometer

Get a list of odometers for multiple services

Request Information

URI Parameters

None.

Body Parameters

OdometerRequestModel
NameDescriptionTypeAdditional information
Token

The token returned after login used for authentication

string

None.

UserID

The user id returned after login used for authentication

unsigned integer

None.

ServiceIDList

A list of service ids being requested

Collection of unsigned integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Token": "sample string 1",
  "UserID": 2,
  "ServiceIDList": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<OdometerRequestModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Token>sample string 1</Token>
  <UserID>2</UserID>
  <ServiceIDList>
    <unsignedLong>1</unsignedLong>
    <unsignedLong>2</unsignedLong>
  </ServiceIDList>
</OdometerRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of OdometerResponseModel details

Collection of OdometerResponseModel
NameDescriptionTypeAdditional information
ServiceID

The service id of the vehicle

unsigned integer

None.

OdometerMeters

The odometer in meters

integer

None.

OdometerMiles

The odometer in miles

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ServiceID": 1,
    "OdometerMeters": 2,
    "OdometerMiles": 3
  },
  {
    "ServiceID": 1,
    "OdometerMeters": 2,
    "OdometerMiles": 3
  }
]

application/xml, text/xml

Sample:
<ArrayOfOdometerResponseModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OdometerResponseModel>
    <ServiceID>1</ServiceID>
    <OdometerMeters>2</OdometerMeters>
    <OdometerMiles>3</OdometerMiles>
  </OdometerResponseModel>
  <OdometerResponseModel>
    <ServiceID>1</ServiceID>
    <OdometerMeters>2</OdometerMeters>
    <OdometerMiles>3</OdometerMiles>
  </OdometerResponseModel>
</ArrayOfOdometerResponseModel>