Skip to main content
GET
/
customer
/
{customerId}
/
idling
/
detail
/
vehicle
Vehicle Idling
curl --request GET \
  --url https://api.masternautconnect.com/connect-webservices/services/public/v1/customer/{customerId}/idling/detail/vehicle \
  --header 'Authorization: Bearer <token>'
{
  "totalPages": 123,
  "totalCount": 123,
  "items": [
    {
      "vehicleId": "<string>",
      "vehicleRegistration": "<string>",
      "vehicleName": "<string>",
      "driverId": "<string>",
      "driverName": "<string>",
      "groupId": "<string>",
      "groupName": "<string>",
      "startDate": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "duration": 123,
      "coordinate": {
        "longitude": 123,
        "latitude": 123
      },
      "address": "<string>",
      "location": {
        "name": "<string>",
        "categoryName": "<string>",
        "id": "<string>",
        "address": {
          "roadNumber": "<string>",
          "road": "<string>",
          "city": "<string>",
          "postCode": "<string>",
          "country": "<string>"
        },
        "coordinate": {
          "longitude": 123,
          "latitude": 123
        },
        "radius": 123,
        "polygon": [
          {
            "longitude": 123,
            "latitude": 123
          }
        ],
        "reference": "<string>",
        "phoneNumber": "<string>",
        "contact": "<string>",
        "email": "<string>",
        "notes": "<string>"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
string
required

Customer identifier

Query Parameters

vehicleId
string

Identifier (alphanumeric) of a vehicle.
Must be specified if a value for groupId has not been specified.

groupId
string

Identifier (alphanumeric) of a group.

startDate
string<date-time>
required

Start date and time of the idling activity block, in UTC, in format of YYYY-MM-DDThh:mm:ss

endDate
string<date-time>
required

End date and time of the idling activity block, in UTC, in format of YYYY-MM-DDThh:mm:ss.

excludeChildGroups
boolean
default:false

Specifies if details for child groups should be excluded and not included in the response.
If not specified, then will default to a false.

pageIndex
integer
default:0

Specifies the pagination page index.
Pages are zero indexed, i.e.
the first page has an index value of zero.
If not specified, then will default to a pageIndex of 0.

pageSize
integer
default:50

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.
If not specified, then will default to a pageSize of 50.
If specified cannot be more than 100.

Required range: x <= 100

Response

Successful operation

Paginated response containing idling activity block results

totalPages
integer

Total number of pages based on the pageSize.

totalCount
integer

Total number of idling activity blocks that matched the search parameters.

items
object[]

Array of idling activity block details.