Skip to main content

Retrieve Submitted Inspection Form

Retrieve the details of an existing Submitted Inspection Form.

info

Submitting inspection forms through the API is not currently supported.

Path Parameters

  • id string required

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

    The id of the relevant record

Responses

OK

Schema

  • id integer

    Possible values: >= 1

  • started_at date

    The date and time at which this Inspection Form was started.

  • submitted_at date

    The date and time at which this Inspection Form was submitted.

  • date string

    The date on which this Inspection Form was submitted, formatted as "Mon DD, YYYY"

  • failed_items integer

    The number of failed items on this Inspection Form.

  • vehicle_id integer

    Possible values: >= 1

  • starting_latitude float

    The latitude at which this Inspection Form was started.

  • starting_longitude float

    The longitude at which this Inspection Form was started.

  • submitted_latitude float

    The latitude at which this Inspection Form was submitted.

  • submitted_longitude float

    The longitude at which this Inspection Form was submitted.

  • duration string

    The duration of time in words (eg; 15 minutes, about 1 hour) between when this Inspection Form was started and when it was submitted.

  • inspection_form object
  • id integer

    Possible values: >= 1

  • title string

    The title of the Inspection Form.

  • description string

    The description of the Inspection Form.

  • contact_id NullableId

    Possible values: >= 1

  • user string

    The full name of the User that submitted this Inspection Form.

  • submitted_inspection_items object[]
  • result object

    This object contains the result of the Submitted Inspection Item. The key:value pair(s) returned vary depending on the type of Inspection Item.

  • id integer

    Possible values: >= 1

  • comments_count integer

    The number of Comments related to this Inspection Item.

  • images_count integer

    The number of Images related to this Inspection Item.

  • submitted_inspection_form_id integer

    Possible values: >= 1

  • latitude float

    The latitude at which this Inspection Item was submitted.

  • longitude float

    The longitude at which this Inspection Item was submitted.

  • inspection_item object
  • label string

    The label or name of the Inspection Item.

  • type string

    Possible values: [InspectionDateItem, InspectionDatetimeItem, InspectionDropdownItem, InspectionFreeTextItem, InspectionMeterEntryItem, InspectionNumericItem, InspectionPassFailItem, InspectionPhotoItem, InspectionSectionItem, InspectionSignatureItem, InspectionSingleCheckboxItem]

    The type or category of the Inspection Item.

  • fail_label string

    The label for a "Fail" result.

  • pass_label string

    The label for a "Pass" result.

  • na_label string

    The label for a "Not Applicable" result.

  • dropdown_options object[]

    An array of options for an InspectionDropdownItem.

  • label string

    The label or name of the Inspection Item.

  • position integer

    The position or order of the Inspection Item within the form.

  • fail_if_chosen boolean

    Indicates whether the inspection should fail if this item is chosen.

  • numeric_range_max float

    The maximum value for an InspectionNumericItem.

  • numeric_range_min float

    The minimum value for an InspectionNumericItem.

  • requirement_settings object

    A dynamically generated list of settings describing required items as part of the inspection form.

  • comments_count integer

    The number of Comments on this Inspection Form.

  • images_count integer

    The number of images attached to this Inspection Form.

Loading...