Skip to main content

Retrieve Inspection Schedule

Retrieve an Inspection Schedule.

Path Parameters

  • id string required

    Possible values: Value must match regular expression ^[0-9]+$

    The id of the relevant record

Query Parameters
  • include_occurrences integer

    Includes upcoming_occurrences for this schedule, if any.

Responses

OK

Schema

  • id integer

    Possible values: >= 1

  • active boolean

    Whether this Inspection Schedule is active.

  • vehicle_id integer

    Possible values: >= 1

  • inspection_form_id integer

    Possible values: >= 1

  • updated_at date-time

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

  • recurring_rule_description string

    This describes the recurrence behavior of the Inspection Schedule.

  • overdue boolean

    Whether this Inspection Schedule is overdue.

  • due_soon boolean

    Whether this Inspection Schedule is due soon.

  • next_due string

    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_time string

    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_at string

    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_occurrences string[]
Loading...