FLfleetio
Inspection Schedules

Retrieve Inspection Schedule

Retrieve an Inspection Schedule.

get/inspection_schedules/{id}

Request

Path parameters

idstring required

The id of the relevant record

Query parameters

include_occurrencesinteger

Includes upcoming_occurrences for this schedule, if any.

Response

OK

idinteger
activeboolean required

Whether this Inspection Schedule is active.

vehicle_idinteger required
inspection_form_idinteger required
updated_atstring date-time

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

recurring_rule_descriptionstring required

This describes the recurrence behavior of the Inspection Schedule.

overdueboolean required

Whether this Inspection Schedule is overdue.

due_soonboolean required

Whether this Inspection Schedule is due soon.

next_duestring

The date on which this Inspection Schedule is next due. This attribute will only appear in responses if there is a next due date.

next_due_relative_timestring

The relative time until this Inspection Schedule is next due. If the Inspection Schedule is overdue, it will describe how long ago it was due. This attribute will only appear in responses if there is a next due date, or overdue.

recurring_schedule_start_atstring

The date on which this Inspection Schedule's recurrence behavior began. This attribute will only appear in responses if the Inspection Schedule is recurring.

upcoming_occurrencesstring[]

Example response

{
  "updated_at": "2023-03-14T13:46:27-06:00",
  "next_due": "October 18, 2023",
  "recurring_schedule_start_at": "October 18, 2023"
}

Changes

No recorded changes to this operation across all 1 revision of this API.