Vehicle Assignments

Retrieve Vehicle Assignment

Retrieve the details of an existing Vehicle Assignment.

get/vehicle_assignments/{id}

Request

Path parameters

idstring required

The id of the relevant record

Response

OK

idinteger required
created_atstring date-time

The date and time at which this record was created.

updated_atstring date-time

The date and time at which this record was most recently updated.

vehicle_idinteger required
contact_idinteger required
started_atstring date-time nullable required

The date and time of this Vehicle Assignment. Dates in the future are accepted. We recommend using ISO-8601 formatted dates to avoid ambiguity.

ended_atstring date-time nullable required

The date and time of this Vehicle Assignment ending. We recommend using ISO-8601 formatted dates to avoid ambiguity.

currentboolean required

Whether this Vehicle Assignment is current/active.

futureboolean required

Whether this Vehicle Assignment is set to take place in the future.

custom_fieldsCustomFields nullable required

*Full details on working with Custom Fields here.

starting_meter_entry_valuestring nullable required

The meter value at the start of this Vehicle Assignment.

ending_meter_entry_valuestring nullable required

The meter value at the end of this Vehicle Assignment.

comments_countinteger required

The number of comments on this Vehicle Assignment.

contact_full_namestring nullable
contact_image_urlstring nullable

The URL pointing to the Contact's image.

Example response

{
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "started_at": "2023-03-14T13:46:27-06:00",
  "ended_at": "2023-03-14T13:46:27-06:00",
  "comments": [
    {
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00"
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.