{ "openapi": "3.0.3", "info": { "title": "Double M ELD Integration Contract", "version": "1.0.0", "description": "Contract reference only. Data endpoints are not deployed on the public website. The reserved example server is non-production. No driver identity, contact, signature, location, or free-text fields are exposed. Operational records remain sensitive." }, "servers": [ { "url": "https://api.example.invalid", "description": "Reserved, intentionally non-resolving example. Replace only with a separately provisioned API origin." } ], "security": [ { "bearerAuth": [] } ], "paths": { "/v1/vehicles": { "get": { "operationId": "list_vehicles", "summary": "List ELD vehicles", "description": "Read the equipment references participating in the authorized ELD integration. This is not a general fleet or driver directory. Assigned-person details and identity expansion are excluded. Results are ordered by vehicle_id.", "tags": [ "Vehicles" ], "x-required-scope": "eld:vehicles:read", "x-availability": "contract-only", "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Use next_cursor unchanged with the same filters." } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "vehicle_id": { "type": "string", "description": "Opaque equipment reference, scoped to this integration." }, "unit_number": { "type": "string", "description": "Equipment unit label; must not contain a person\u2019s name." }, "connection_state": { "type": "string", "description": "Most recent ELD connection state.", "enum": [ "connected", "disconnected", "unknown" ] }, "last_observed_at": { "type": "string", "format": "date-time", "description": "Last accepted observation; null if none exists.", "nullable": true } }, "required": [ "vehicle_id", "unit_number", "connection_state", "last_observed_at" ] } }, "next_cursor": { "type": "string", "nullable": true, "description": "Opaque continuation token; null ends the traversal." } }, "required": [ "data", "next_cursor" ] }, "example": { "data": [ { "vehicle_id": "veh_example_014", "unit_number": "014", "connection_state": "connected", "last_observed_at": "2026-10-15T16:00:00Z" } ], "next_cursor": null } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/vehicles/{vehicle_id}": { "get": { "operationId": "get_vehicle", "summary": "Get an ELD vehicle", "description": "Read the current ELD connection summary for one equipment reference. An inaccessible vehicle and a nonexistent vehicle both return 404.", "tags": [ "Vehicles" ], "x-required-scope": "eld:vehicles:read", "x-availability": "contract-only", "parameters": [ { "name": "vehicle_id", "in": "path", "required": true, "description": "Opaque resource reference scoped to the authorized integration.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "vehicle_id": { "type": "string", "description": "Opaque equipment reference, scoped to this integration." }, "unit_number": { "type": "string", "description": "Equipment unit label; must not contain a person\u2019s name." }, "connection_state": { "type": "string", "description": "Most recent ELD connection state.", "enum": [ "connected", "disconnected", "unknown" ] }, "last_observed_at": { "type": "string", "format": "date-time", "description": "Last accepted observation; null if none exists.", "nullable": true } }, "required": [ "vehicle_id", "unit_number", "connection_state", "last_observed_at" ] } }, "required": [ "data" ] }, "example": { "data": { "vehicle_id": "veh_example_014", "unit_number": "014", "connection_state": "connected", "last_observed_at": "2026-10-15T16:00:00Z" } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/eld-devices": { "get": { "operationId": "list_devices", "summary": "List ELD devices", "description": "Read the interface metadata associated with ELD-equipped vehicles. Device records do not establish hardware compatibility or certification. Example firmware is fabricated. Results are ordered by device_id.", "tags": [ "ELD devices" ], "x-required-scope": "eld:devices:read", "x-availability": "contract-only", "parameters": [ { "name": "vehicle_id", "in": "query", "required": false, "description": "Optional equipment reference; only resources authorized to this integration.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Use next_cursor unchanged with the same filters." } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "device_id": { "type": "string", "description": "Opaque ELD interface reference." }, "vehicle_id": { "type": "string", "description": "Associated equipment reference; null if unassigned.", "nullable": true }, "firmware_version": { "type": "string", "description": "Reported firmware version; null if unavailable.", "nullable": true }, "connection_state": { "type": "string", "description": "Observed connection state.", "enum": [ "connected", "disconnected", "unknown" ] }, "last_seen_at": { "type": "string", "format": "date-time", "description": "Time of the latest accepted device observation.", "nullable": true } }, "required": [ "device_id", "vehicle_id", "firmware_version", "connection_state", "last_seen_at" ] } }, "next_cursor": { "type": "string", "nullable": true, "description": "Opaque continuation token; null ends the traversal." } }, "required": [ "data", "next_cursor" ] }, "example": { "data": [ { "device_id": "eld_example_014", "vehicle_id": "veh_example_014", "firmware_version": "example-1.0", "connection_state": "connected", "last_seen_at": "2026-10-15T16:00:00Z" } ], "next_cursor": null } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/eld-devices/{device_id}": { "get": { "operationId": "get_device", "summary": "Get an ELD device", "description": "Inspect one interface record and its observed connection state. Radio connectivity does not guarantee complete or fresh engine observations.", "tags": [ "ELD devices" ], "x-required-scope": "eld:devices:read", "x-availability": "contract-only", "parameters": [ { "name": "device_id", "in": "path", "required": true, "description": "Opaque resource reference scoped to the authorized integration.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "device_id": { "type": "string", "description": "Opaque ELD interface reference." }, "vehicle_id": { "type": "string", "description": "Associated equipment reference; null if unassigned.", "nullable": true }, "firmware_version": { "type": "string", "description": "Reported firmware version; null if unavailable.", "nullable": true }, "connection_state": { "type": "string", "description": "Observed connection state.", "enum": [ "connected", "disconnected", "unknown" ] }, "last_seen_at": { "type": "string", "format": "date-time", "description": "Time of the latest accepted device observation.", "nullable": true } }, "required": [ "device_id", "vehicle_id", "firmware_version", "connection_state", "last_seen_at" ] } }, "required": [ "data" ] }, "example": { "data": { "device_id": "eld_example_014", "vehicle_id": "veh_example_014", "firmware_version": "example-1.0", "connection_state": "connected", "last_seen_at": "2026-10-15T16:00:00Z" } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/vehicle-connections": { "get": { "operationId": "list_connections", "summary": "List connection events", "description": "Review changes in the local vehicle-to-mobile-device connection. Bluetooth availability and internet synchronization are separate states. This resource concerns the vehicle connection.", "tags": [ "Connections" ], "x-required-scope": "eld:vehicles:read", "x-availability": "contract-only", "parameters": [ { "name": "from", "in": "query", "required": true, "description": "Inclusive UTC start. Required; range cannot exceed 31 days.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": true, "description": "Exclusive UTC end. Must follow from.", "schema": { "type": "string", "format": "date-time" } }, { "name": "vehicle_id", "in": "query", "required": false, "description": "Optional equipment reference; only resources authorized to this integration.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Use next_cursor unchanged with the same filters." } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "event_id": { "type": "string", "description": "Opaque connection-event reference." }, "vehicle_id": { "type": "string", "description": "Equipment reference." }, "device_id": { "type": "string", "description": "Interface reference." }, "recorded_at": { "type": "string", "format": "date-time", "description": "UTC observation time." }, "state": { "type": "string", "description": "Connection state after this event.", "enum": [ "connected", "disconnected", "unknown" ] }, "reason_code": { "type": "string", "description": "Structured cause without free-text details.", "enum": [ "link_established", "link_lost", "power_off", "unknown" ] } }, "required": [ "event_id", "vehicle_id", "device_id", "recorded_at", "state", "reason_code" ] } }, "next_cursor": { "type": "string", "nullable": true, "description": "Opaque continuation token; null ends the traversal." } }, "required": [ "data", "next_cursor" ] }, "example": { "data": [ { "event_id": "evt_example_connection_1", "vehicle_id": "veh_example_014", "device_id": "eld_example_014", "recorded_at": "2026-10-15T06:00:00Z", "state": "connected", "reason_code": "link_established" } ], "next_cursor": null } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/engine-events": { "get": { "operationId": "list_engine_events", "summary": "List engine events", "description": "Read source-qualified engine observations relevant to electronic logging. This is an ELD observation feed, not a diagnostic scanner, location feed, or maintenance API. Null values remain unavailable. Do not substitute phone GPS for missing ECM measurements.", "tags": [ "Engine events" ], "x-required-scope": "eld:events:read", "x-availability": "contract-only", "parameters": [ { "name": "from", "in": "query", "required": true, "description": "Inclusive UTC start. Required; range cannot exceed 31 days.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": true, "description": "Exclusive UTC end. Must follow from.", "schema": { "type": "string", "format": "date-time" } }, { "name": "vehicle_id", "in": "query", "required": false, "description": "Optional equipment reference; only resources authorized to this integration.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Use next_cursor unchanged with the same filters." } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "event_id": { "type": "string", "description": "Opaque observation reference." }, "vehicle_id": { "type": "string", "description": "Equipment reference." }, "recorded_at": { "type": "string", "format": "date-time", "description": "UTC capture time." }, "source": { "type": "string", "description": "Origin of the measurement.", "enum": [ "ecm" ] }, "quality": { "type": "string", "description": "Quality of the observation.", "enum": [ "valid", "stale", "unavailable" ] }, "engine_power": { "type": "string", "description": "Observed engine-power state.", "enum": [ "on", "off", "unknown" ] }, "vehicle_motion": { "type": "boolean", "description": "Whether motion was observed; null if unavailable.", "nullable": true }, "distance_meters": { "type": "number", "minimum": 0, "description": "Accumulated ECM distance in meters; null if missing.", "nullable": true }, "engine_seconds": { "type": "integer", "minimum": 0, "description": "Accumulated ECM engine operating time in seconds.", "nullable": true } }, "required": [ "event_id", "vehicle_id", "recorded_at", "source", "quality", "engine_power", "vehicle_motion", "distance_meters", "engine_seconds" ] } }, "next_cursor": { "type": "string", "nullable": true, "description": "Opaque continuation token; null ends the traversal." } }, "required": [ "data", "next_cursor" ] }, "example": { "data": [ { "event_id": "evt_example_engine_1", "vehicle_id": "veh_example_014", "recorded_at": "2026-10-15T16:00:00Z", "source": "ecm", "quality": "valid", "engine_power": "on", "vehicle_motion": false, "distance_meters": 482160000, "engine_seconds": 24012000 } ], "next_cursor": null } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/daily-logs": { "get": { "operationId": "list_daily_logs", "summary": "List daily logs", "description": "Read reduced daily-record summaries within the authorized integration. This privacy-limited representation is not an inspection record or FMCSA transfer file. It has no driver association field. The example is a complete 24-hour UTC day: 14 hours off duty, 8 driving, and 2 on duty. Results use updated_at, then log_id.", "tags": [ "Daily logs" ], "x-required-scope": "eld:logs:read", "x-availability": "contract-only", "parameters": [ { "name": "updated_after", "in": "query", "required": false, "description": "Optional exclusive UTC revision watermark. Deduplicate by log_id and revision.", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Use next_cursor unchanged with the same filters." } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "log_id": { "type": "string", "description": "Opaque daily-record reference. No identity lookup is provided." }, "log_date": { "type": "string", "format": "date", "description": "Local date represented by this record." }, "time_zone": { "type": "string", "description": "IANA timezone for the daily boundary." }, "period_seconds": { "type": "integer", "minimum": 0, "description": "Actual duration covered by this daily summary." }, "off_duty_seconds": { "type": "integer", "minimum": 0, "description": "Off-duty time within the period." }, "sleeper_seconds": { "type": "integer", "minimum": 0, "description": "Sleeper-berth time within the period." }, "driving_seconds": { "type": "integer", "minimum": 0, "description": "Driving time within the period." }, "on_duty_seconds": { "type": "integer", "minimum": 0, "description": "On-duty, not-driving time within the period." }, "certification_status": { "type": "string", "description": "Certification state without identity or signature.", "enum": [ "uncertified", "certified", "recertification_required" ] }, "revision": { "type": "integer", "minimum": 0, "description": "Monotonically increasing record revision." }, "updated_at": { "type": "string", "format": "date-time", "description": "UTC time of the latest accepted revision." } }, "required": [ "log_id", "log_date", "time_zone", "period_seconds", "off_duty_seconds", "sleeper_seconds", "driving_seconds", "on_duty_seconds", "certification_status", "revision", "updated_at" ] } }, "next_cursor": { "type": "string", "nullable": true, "description": "Opaque continuation token; null ends the traversal." } }, "required": [ "data", "next_cursor" ] }, "example": { "data": [ { "log_id": "log_example_7f2a", "log_date": "2026-10-15", "time_zone": "Etc/UTC", "period_seconds": 86400, "off_duty_seconds": 50400, "sleeper_seconds": 0, "driving_seconds": 28800, "on_duty_seconds": 7200, "certification_status": "uncertified", "revision": 1, "updated_at": "2026-10-16T00:00:00Z" } ], "next_cursor": null } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/daily-logs/{log_id}": { "get": { "operationId": "get_daily_log", "summary": "Get a daily log", "description": "Read the allowed summary fields for one daily record. Use revision when comparing snapshots. Certification status alone is not a driver signature or certification evidence.", "tags": [ "Daily logs" ], "x-required-scope": "eld:logs:read", "x-availability": "contract-only", "parameters": [ { "name": "log_id", "in": "path", "required": true, "description": "Opaque resource reference scoped to the authorized integration.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "log_id": { "type": "string", "description": "Opaque daily-record reference. No identity lookup is provided." }, "log_date": { "type": "string", "format": "date", "description": "Local date represented by this record." }, "time_zone": { "type": "string", "description": "IANA timezone for the daily boundary." }, "period_seconds": { "type": "integer", "minimum": 0, "description": "Actual duration covered by this daily summary." }, "off_duty_seconds": { "type": "integer", "minimum": 0, "description": "Off-duty time within the period." }, "sleeper_seconds": { "type": "integer", "minimum": 0, "description": "Sleeper-berth time within the period." }, "driving_seconds": { "type": "integer", "minimum": 0, "description": "Driving time within the period." }, "on_duty_seconds": { "type": "integer", "minimum": 0, "description": "On-duty, not-driving time within the period." }, "certification_status": { "type": "string", "description": "Certification state without identity or signature.", "enum": [ "uncertified", "certified", "recertification_required" ] }, "revision": { "type": "integer", "minimum": 0, "description": "Monotonically increasing record revision." }, "updated_at": { "type": "string", "format": "date-time", "description": "UTC time of the latest accepted revision." } }, "required": [ "log_id", "log_date", "time_zone", "period_seconds", "off_duty_seconds", "sleeper_seconds", "driving_seconds", "on_duty_seconds", "certification_status", "revision", "updated_at" ] } }, "required": [ "data" ] }, "example": { "data": { "log_id": "log_example_7f2a", "log_date": "2026-10-15", "time_zone": "Etc/UTC", "period_seconds": 86400, "off_duty_seconds": 50400, "sleeper_seconds": 0, "driving_seconds": 28800, "on_duty_seconds": 7200, "certification_status": "uncertified", "revision": 1, "updated_at": "2026-10-16T00:00:00Z" } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/duty-status-events": { "get": { "operationId": "list_duty_events", "summary": "List duty-status events", "description": "Read structured duty-status transitions for an authorized daily record. A transition establishes the status beginning at recorded_at. The following event or period boundary determines its end. Free-text annotations, location, actor identity, and driver lookup fields are excluded.", "tags": [ "Duty status" ], "x-required-scope": "eld:logs:read", "x-availability": "contract-only", "parameters": [ { "name": "log_id", "in": "query", "required": true, "description": "Required opaque daily-record reference.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": true, "description": "Inclusive UTC start. Required; range cannot exceed 31 days.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": true, "description": "Exclusive UTC end. Must follow from.", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Use next_cursor unchanged with the same filters." } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "event_id": { "type": "string", "description": "Opaque duty-event reference." }, "log_id": { "type": "string", "description": "Daily-record reference." }, "recorded_at": { "type": "string", "format": "date-time", "description": "UTC time the transition took effect." }, "duty_status": { "type": "string", "description": "Resulting duty state.", "enum": [ "off_duty", "sleeper_berth", "driving", "on_duty" ] }, "operating_category": { "type": "string", "description": "Special operating category, without location data.", "enum": [ "normal", "personal_conveyance", "yard_move" ] }, "source": { "type": "string", "description": "Provenance category; not an actor identifier.", "enum": [ "engine", "manual", "accepted_edit" ] }, "revision": { "type": "integer", "minimum": 0, "description": "Version of this event." } }, "required": [ "event_id", "log_id", "recorded_at", "duty_status", "operating_category", "source", "revision" ] } }, "next_cursor": { "type": "string", "nullable": true, "description": "Opaque continuation token; null ends the traversal." } }, "required": [ "data", "next_cursor" ] }, "example": { "data": [ { "event_id": "evt_example_duty_1", "log_id": "log_example_7f2a", "recorded_at": "2026-10-15T07:00:00Z", "duty_status": "driving", "operating_category": "normal", "source": "engine", "revision": 1 } ], "next_cursor": null } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/daily-logs/{log_id}/hos": { "get": { "operationId": "get_hos_summary", "summary": "Get an HOS summary", "description": "Read the calculated clock snapshot associated with an authorized log. Clocks are independent constraints, not permission to drive or a compliance determination. Rule selection and exceptions require validated calculation logic. A null clock means the calculation is unavailable. The sample is a 16:00 UTC snapshot; it is separate from the final daily totals.", "tags": [ "Hours of service" ], "x-required-scope": "eld:hos:read", "x-availability": "contract-only", "parameters": [ { "name": "log_id", "in": "path", "required": true, "description": "Opaque resource reference scoped to the authorized integration.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "object", "additionalProperties": false, "properties": { "log_id": { "type": "string", "description": "Daily-record reference." }, "as_of": { "type": "string", "format": "date-time", "description": "UTC calculation snapshot time." }, "rule_set": { "type": "string", "description": "Versioned rule identifier, not evidence of certification." }, "calculation_state": { "type": "string", "description": "Whether required inputs were available.", "enum": [ "available", "incomplete" ] }, "driving_remaining_seconds": { "type": "integer", "minimum": 0, "description": "Remaining driving-clock seconds; null if unavailable.", "nullable": true }, "shift_remaining_seconds": { "type": "integer", "minimum": 0, "description": "Remaining shift-window seconds; null if unavailable.", "nullable": true }, "cycle_remaining_seconds": { "type": "integer", "minimum": 0, "description": "Remaining cycle-clock seconds; null if unavailable.", "nullable": true } }, "required": [ "log_id", "as_of", "rule_set", "calculation_state", "driving_remaining_seconds", "shift_remaining_seconds", "cycle_remaining_seconds" ] } }, "required": [ "data" ] }, "example": { "data": { "log_id": "log_example_7f2a", "as_of": "2026-10-15T16:00:00Z", "rule_set": "us_property_70_8_contract_v1", "calculation_state": "available", "driving_remaining_seconds": 10800, "shift_remaining_seconds": 14400, "cycle_remaining_seconds": 79200 } } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/eld-diagnostics": { "get": { "operationId": "list_diagnostics", "summary": "List ELD diagnostics", "description": "Review structured ELD diagnostic and malfunction observations. These categories describe ELD data health, not general vehicle fault codes or maintenance alerts. An empty result does not prove device compliance or successful malfunction monitoring.", "tags": [ "Diagnostics" ], "x-required-scope": "eld:diagnostics:read", "x-availability": "contract-only", "parameters": [ { "name": "from", "in": "query", "required": true, "description": "Inclusive UTC start. Required; range cannot exceed 31 days.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": true, "description": "Exclusive UTC end. Must follow from.", "schema": { "type": "string", "format": "date-time" } }, { "name": "vehicle_id", "in": "query", "required": false, "description": "Optional equipment reference; only resources authorized to this integration.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Use next_cursor unchanged with the same filters." } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "event_id": { "type": "string", "description": "Opaque health-event reference." }, "device_id": { "type": "string", "description": "Interface reference." }, "vehicle_id": { "type": "string", "description": "Equipment reference." }, "recorded_at": { "type": "string", "format": "date-time", "description": "UTC observation time." }, "kind": { "type": "string", "description": "Type of ELD health event.", "enum": [ "diagnostic", "malfunction" ] }, "category": { "type": "string", "description": "Structured data-health category.", "enum": [ "power", "engine_synchronization", "timing", "positioning", "data_recording", "data_transfer", "unidentified_records" ] }, "state": { "type": "string", "description": "Whether the condition is active or cleared.", "enum": [ "active", "cleared" ] } }, "required": [ "event_id", "device_id", "vehicle_id", "recorded_at", "kind", "category", "state" ] } }, "next_cursor": { "type": "string", "nullable": true, "description": "Opaque continuation token; null ends the traversal." } }, "required": [ "data", "next_cursor" ] }, "example": { "data": [ { "event_id": "evt_example_diagnostic_1", "device_id": "eld_example_014", "vehicle_id": "veh_example_014", "recorded_at": "2026-10-15T16:05:00Z", "kind": "diagnostic", "category": "engine_synchronization", "state": "active" } ], "next_cursor": null } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/audit-events": { "get": { "operationId": "list_audit_events", "summary": "List record audit events", "description": "Read structured changes to an authorized ELD record without exposing the actor. No actor identifier, name, annotation text, signature, or source document is returned. This integration history is a reduced representation; it does not replace the complete regulated audit trail.", "tags": [ "Audit history" ], "x-required-scope": "eld:audit:read", "x-availability": "contract-only", "parameters": [ { "name": "log_id", "in": "query", "required": true, "description": "Required opaque daily-record reference.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "required": true, "description": "Inclusive UTC start. Required; range cannot exceed 31 days.", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "required": true, "description": "Exclusive UTC end. Must follow from.", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "schema": { "type": "string" }, "description": "Use next_cursor unchanged with the same filters." } ], "responses": { "200": { "description": "Illustrative contract response; no live data endpoint is deployed on this website.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "event_id": { "type": "string", "description": "Opaque audit-event reference." }, "log_id": { "type": "string", "description": "Daily-record reference." }, "recorded_at": { "type": "string", "format": "date-time", "description": "UTC time of the accepted change." }, "action": { "type": "string", "description": "Structured action category.", "enum": [ "record_created", "record_revised", "certification_recorded", "recertification_required" ] }, "revision": { "type": "integer", "minimum": 0, "description": "Resulting record revision." } }, "required": [ "event_id", "log_id", "recorded_at", "action", "revision" ] } }, "next_cursor": { "type": "string", "nullable": true, "description": "Opaque continuation token; null ends the traversal." } }, "required": [ "data", "next_cursor" ] }, "example": { "data": [ { "event_id": "evt_example_audit_1", "log_id": "log_example_7f2a", "recorded_at": "2026-10-16T00:00:00Z", "action": "record_created", "revision": 1 } ], "next_cursor": null } } } }, "400": { "description": "Invalid parameters", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Insufficient scope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found or not accessible", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit reached; honor Retry-After", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Integration-scoped server-side credential; token issuance is outside this website." } }, "schemas": { "Error": { "type": "object", "additionalProperties": false, "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string" }, "message": { "type": "string", "description": "Fixed safe message, without request values or personal information." }, "request_id": { "type": "string" } } } } } }