| Code + | +Description + | +
| 200 OK + | +The audit was successfully recorded. The response body contains information about the registered provider vehicle being audited, for example:
+
+```js
+{
+ provider_id: UUID,
+ provider_name: string,
+ provider_vehicle_id: string,
+ provider_device: {...}
+}
+```
+ +A `null` provider device indicates a registered vehicle was not found for the specified provider + |
+
| 400 Bad Request + | +A validation error occurred + | +
| 409 Conflict + | +An audit for the specified `audit_trip_id` already exists + | +
| Code + | +Description + | +
| 200 OK + | +This response contains the total count of all matching audits as well as a list of matching audits. If paging parameters are specified there may be fewer results returned than the total count of all matches. + +```js +{ + count: number, + audits: { + audit_trip_id: UUID, + audit_device_id: UUID, + audit_subject_id: string, + provider_id: UUID, + provider_name: string, + provider_vehicle_id: string, + provider_device_id: UUID, + timestamp: Timestamp, + recorded: Timestamp, + deleted: bool, + attachments: { + attachment_id: UUID, + attachment_url: string, + thumbnail_url: string + }[] + }[] +} +``` + | +
| 400 Bad Request + | +A validation error occurred + | +
| Code + | +Description + | +
| 200 OK + | +This response contains details, events, and telemetry for the specified audit and associated provider vehicle trip. + +```js +{ + audit_trip_id: UUID, + audit_device_id: UUID, + audit_subject_id: string, + provider_id: UUID, + provider_name: string, + provider_vehicle_id: string, + provider_device_id: UUID | null, + provider_event_type: string | null, + provider_event_type_reason: string | null, + provider_event_time: Timestamp | null, + provider_status: string | null, + provider_telemetry: { + timestamp: Timestamp, + gps: { + lat: float, + lng: float, + speed: float, + heading: float, + accuracy: float, + altitude: float + } + charge: float + } | null, + timestamp: Timestamp, + recorded: Timestamp, + attachments: { + attachment_id: UUID, + attachment_url: string, + thumbnail_url: string + }[], + events: { + audit_trip_id: UUID, + audit_event_id: UUID, + audit_event_type: enum, + audit_issue_code: string, + audit_subject_id: string, + note: string, + timestamp: Timestamp, + gps: { + lat: float, + lng: float, + speed: float, + heading: float, + accuracy: float, + altitude: float + }, + charge: float, + recorded: Timestamp + }[], + provider: null | { + device: { + device_id: UUID, + provider_id: UUID, + vehicle_id: string, + type: string, + propulsion: string[], + year: number, + mfgr: string, + model: string, + recorded: Timestamp + }, + events: { + device_id: UUID, + provider_id: UUID, + timestamp: Timestamp, + event_type: enum, + event_type_reason: string, + telemetry_timestamp: Timestamp, + trip_id: UUID, + recorded: Timestamp, + }[], + telemetry: { + device_id: UUID, + provider_id: UUID, + timestamp: Timestamp, + gps: { + lat: float, + lng: float, + speed: float, + heading: float, + accuracy: float, + altitude: float + }, + charge: float, + recorded: Timestamp + }[] + } +} +``` + | +
| 404 Not Found + | +An audit for the specified `audit_trip_id` does not exist + | +
| Code + | +Description + | +
| 200 OK + | +The vehicles were fetched successfully. Note that a 200 response is still returned even if no vehicles were found within the bbox. The response body contains a list of vehicles, with telemetry information for each: + +```js +{ + device_id: UUID, + provider_id: UUID, + vehicle_id: string, + type: string, + propulsion: string[], + year: number, + mfgr: string, + model: string, + recorded: Timestamp, + status: string, + timestamp: Timestamp, + timestamp_long: string | null, + delta: Timestamp | null, + event_type: string, + telemetry_timestamp: Timestamp | null, + telemetry: { + charge: float | null, + device_id: UUID, + provider_id: UUID, + gps:{ + lat: float, + lng: float, + speed: float | null, + satellites: float | null, + heading: float | null, + hdop: float | null, + altitude: float | null + }, + recorded: Timestamp, + timestamp: Timestamp + }, + trip_id: UUID | null, + service_area_id: UUID | null, + updated: Timestamp +}[] +``` + | +
| Code + | +Description + | +
| 200 OK + | +The vehicle was found. The response body contains information about the vehicle: + +```js +{ + device_id: UUID, + provider_id: UUID, + vehicle_id: string, + type: string, + propulsion: string[], + year: number, + mfgr: string, + model: string, + recorded: Timestamp, + status: string, + timestamp: Timestamp, + timestamp_long: string | null, + delta: Timestamp | null, + event_type: string, + telemetry_timestamp: Timestamp | null, + telemetry: { + charge: float, + device_id: UUID, + provider_id: UUID, + gps:{ + lat: float, + lng: float, + speed: float, + satellites: float | null, + heading: float, + hdop: float, + altitude: float | null + }, + recorded: Timestamp, + timestamp: Timestamp + }, + trip_id: UUID | null, + service_area_id: UUID | null, + updated: Timestamp +}[] +``` + | +
| 404 Not Found + | +No vehicles matching the given VIN and provider were found. + | +
| Code + | +Description + | +
| 200 OK + | +The attachment was stored successfully. The response body contains information about the attachment, including URLs where it and its thumbnail can be found: + +```js +{ + audit_trip_id: UUID, + attachment_id: UUID, + attachment_url: string, + thumbnail_url: string +} +``` + | +
| 400 Bad Request + | +No attachment was included in the request body, or the filename was missing an extension. + | +
| 404 Not Found + | +The specified `audit_trip_id` does not exist. + | +
| 415 Unsupported Media Type + | +The file's `mimetype` is not currently supported. + | +