Retrieve Submitted Inspection Form

GET 
https://secure.fleetio.com/api/v1/submitted_inspection_forms/:id

Retrieve the details of an existing Submitted Inspection Form.

info

Submitting inspection forms through the API is not currently supported.

Request

Path Parameters

id stringrequired

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

The id of the relevant record

Responses

200

OK

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

started_atdaterequired

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

Example: 2023-03-14

submitted_atdaterequired

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

Example: 2023-03-14

datestringrequired

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

failed_itemsintegerrequired

The number of failed items on this Inspection Form.

vehicle_idId (integer)required

Possible values: >= 1

starting_latitudefloatnullablerequired

The latitude at which this Inspection Form was started.

starting_longitudefloatnullablerequired

The longitude at which this Inspection Form was started.

submitted_latitudefloatnullablerequired

The latitude at which this Inspection Form was submitted.

submitted_longitudefloatnullablerequired

The longitude at which this Inspection Form was submitted.

durationstringnullablerequired

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 objectrequired

idId (integer)

Possible values: >= 1

titlestring

The title of the Inspection Form.

descriptionstring

The description of the Inspection Form.

contact_idNullableId (integer)nullable

Possible values: >= 1

userstring

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

submitted_inspection_items object[]required

Array [

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.

property name*any

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

idId (integer)

Possible values: >= 1

comments_countinteger

The number of Comments related to this Inspection Item.

images_countinteger

The number of Images related to this Inspection Item.

submitted_inspection_form_idId (integer)

Possible values: >= 1

latitudefloat

The latitude at which this Inspection Item was submitted.

longitudefloat

The longitude at which this Inspection Item was submitted.

inspection_item object

labelstring

The label or name of the Inspection Item.

typestring

The type or category of the Inspection Item.

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

fail_labelstring

The label for a "Fail" result.

pass_labelstring

The label for a "Pass" result.

na_labelstring

The label for a "Not Applicable" result.

dropdown_options object[]

An array of options for an InspectionDropdownItem.

Array [

labelstring

The label or name of the Inspection Item.

positioninteger

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

fail_if_chosenboolean

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

]

numeric_range_maxfloat

The maximum value for an InspectionNumericItem.

numeric_range_minfloat

The minimum value for an InspectionNumericItem.

requirement_settingsobject

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

]

comments_countintegerrequired

The number of Comments on this Inspection Form.

images_countintegerrequired

The number of images attached to this Inspection Form.

Example (auto)

{
  "id": 0,
  "started_at": "2023-03-14",
  "submitted_at": "2023-03-14",
  "date": "string",
  "failed_items": 0,
  "vehicle_id": 0,
  "starting_latitude": 0,
  "starting_longitude": 0,
  "submitted_latitude": 0,
  "submitted_longitude": 0,
  "duration": "string",
  "inspection_form": {
    "id": 0,
    "title": "string",
    "description": "string"
  },
  "contact_id": 0,
  "user": "string",
  "submitted_inspection_items": [
    {
      "result": {},
      "id": 0,
      "comments_count": 0,
      "images_count": 0,
      "submitted_inspection_form_id": 0,
      "latitude": 0,
      "longitude": 0,
      "inspection_item": {
        "label": "string",
        "type": "InspectionDateItem",
        "fail_label": "string",
        "pass_label": "string",
        "na_label": "string",
        "dropdown_options": [
          {
            "label": "string",
            "position": 0,
            "fail_if_chosen": true
          }
        ],
        "numeric_range_max": 0,
        "numeric_range_min": 0,
        "requirement_settings": {}
      }
    }
  ],
  "comments_count": 0,
  "images_count": 0
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

403

Insufficient permission to perform this operation

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

404

The requested resource could not be located

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v1/submitted_inspection_forms/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!