{ "components": { "parameters": { "V1DispatchRouteIdOrExternalIdParam": { "description": "ID of the route. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `payrollId:ABFS18600`", "in": "path", "name": "route_id_or_external_id", "required": true, "schema": { "type": "string" } }, "V1assetHistoryEndTimeParam": { "description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs.", "in": "query", "name": "endMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1assetHistoryStartTimeParam": { "description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs.", "in": "query", "name": "startMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1assetIdParam": { "description": "ID of the asset. Must contain only digits 0-9.", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1dataInputEndTimeParam": { "description": "Timestamp in unix milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs. Defaults to nowMs.", "in": "query", "name": "endMs", "schema": { "format": "int64", "type": "integer" } }, "V1dataInputIdParam": { "description": "ID of the data input. Must contain only digits 0-9.", "in": "path", "name": "data_input_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1dataInputStartTimeParam": { "description": "Timestamp in unix milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs. defaults to nowMs.", "in": "query", "name": "startMs", "schema": { "format": "int64", "type": "integer" } }, "V1documentQueryByParam": { "description": "Retrieve most recent documents based on either driver creation time or driver update time. If no value is provided, the default is `\"created\"`.", "in": "query", "name": "queryBy", "schema": { "enum": [ "created", "updated" ], "format": "string", "type": "string" } }, "V1documentsDurationMsParam": { "description": "Time in milliseconds that represents the duration before endMs to query. Defaults to 24 hours.", "in": "query", "name": "durationMs", "schema": { "format": "int64", "type": "integer" } }, "V1documentsEndMsParam": { "description": "Time in unix milliseconds that represents the oldest documents to return. Used in combination with durationMs. Defaults to now.", "in": "query", "name": "endMs", "schema": { "format": "int64", "type": "integer" } }, "V1getMessagesDurationMsParam": { "description": "Time in milliseconds that represents the duration before endMs to query. Defaults to 24 hours.", "in": "query", "name": "durationMs", "schema": { "format": "int64", "type": "integer" } }, "V1getMessagesEndMsParam": { "description": "Time in unix milliseconds that represents the end of time range of messages to return. Used in combination with durationMs. Defaults to now.", "in": "query", "name": "endMs", "schema": { "format": "int64", "type": "integer" } }, "V1harshEventMsParam": { "description": "Timestamp in milliseconds representing the timestamp of a harsh event.", "in": "query", "name": "timestamp", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1paginationEndingBeforeParam": { "description": "Pagination parameter indicating the cursor position to return results before. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'startingAfter' parameter.", "in": "query", "name": "endingBefore", "schema": { "type": "string" } }, "V1paginationLimitParam": { "description": "Pagination parameter indicating the number of results to return in this request. Used in conjunction with either 'startingAfter' or 'endingBefore'.", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "number" } }, "V1paginationStartingAfterParam": { "description": "Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'endingBefore' parameter.", "in": "query", "name": "startingAfter", "schema": { "type": "string" } }, "V1routeDurationParam": { "description": "Time in milliseconds that represents the duration before end_time to query. Defaults to 24 hours.", "in": "query", "name": "duration", "schema": { "format": "int64", "type": "integer" } }, "V1routeEndTimeParam": { "description": "Time in unix milliseconds that represents the end time of the requested time interval. See above for a description of how routes are returned. Defaults to now.", "in": "query", "name": "end_time", "schema": { "format": "int64", "type": "integer" } }, "V1routeHistoryEndTimeParam": { "description": "Timestamp representing the end of the period to fetch, inclusive. Used in combination with start_time. Defaults to nowMs.", "in": "query", "name": "end_time", "schema": { "format": "int64", "type": "integer" } }, "V1routeHistoryStartTimeParam": { "description": "Timestamp representing the start of the period to fetch, inclusive. Used in combination with end_time. Defaults to 0.", "in": "query", "name": "start_time", "schema": { "format": "int64", "type": "integer" } }, "V1safetyScoreEndMsParam": { "description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour.", "in": "query", "name": "endMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1safetyScoreStartMsParam": { "description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour.", "in": "query", "name": "startMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1visionCameraIdParam": { "description": "The camera_id should be valid for the given accessToken.", "in": "path", "name": "camera_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1visionDurationMsParam": { "description": "DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched", "in": "query", "name": "durationMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1visionEndMsParam": { "description": "EndMs is an optional param. It will default to the current time.", "in": "query", "name": "endMs", "schema": { "format": "int64", "type": "integer" } }, "V1visionIncludeParam": { "description": "Include is a filter parameter. Accepts 'pass', 'reject' or 'no_read'.", "in": "query", "name": "include", "schema": { "type": "string" } }, "V1visionLimitParam": { "description": "Limit is an integer value from 1 to 1,000.", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "integer" } }, "V1visionProgramIdParam": { "description": "The configured program's ID on the camera.", "in": "query", "name": "program_id", "schema": { "format": "int64", "type": "integer" } }, "V1visionProgramIdPathParam": { "description": "The configured program's ID on the camera.", "in": "path", "name": "program_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, "V1visionStartAtMsParam": { "description": "EndMs is an optional param. It will default to the current time.", "in": "query", "name": "startedAtMs", "schema": { "format": "int64", "type": "integer" } }, "V1visionStartAtMsPathParam": { "description": "Started_at_ms is a required param. Indicates the start time of the run to be fetched.", "in": "path", "name": "started_at_ms", "required": true, "schema": { "format": "int64", "type": "integer" } }, "decorationStatTypes": { "description": "Decorations to add to the primary stats listed in the `types` parameter. For example, if you wish to know the vehicle's location whenever the engine changes state, you may set `types=engineStates&decorations=gps`.\n\nYou may list ***up to 2*** decorations using comma-separated format. If multiple stats are listed in the `types` parameter, the decorations will be added to each one. For example: `types=engineStates,obdOdometerMeters,faultCodes&decorations=gps,fuelPercents` will list GPS and fuel decorations for each engine state change, each odometer reading, and each fault code. See the \u003Ca href=\"/docs/telematics#query-parameters\" target=\"_blank\"\u003ETelematics\u003C/a\u003E guide for more details.\n\nNote that decorations may significantly increase the response payload size.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary inputs\u003C/a\u003E for the vehicle.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use \u003Ca href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\"\u003EGet engine immobilizer states\u003C/a\u003E to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted.\n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast mode’.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)", "explode": false, "in": "query", "name": "decorations", "schema": { "items": { "enum": [ "ambientAirTemperatureMilliC", "auxInput1", "auxInput2", "auxInput3", "auxInput4", "auxInput5", "auxInput6", "auxInput7", "auxInput8", "auxInput9", "auxInput10", "auxInput11", "auxInput12", "auxInput13", "batteryMilliVolts", "barometricPressurePa", "defLevelMilliPercent", "ecuSpeedMph", "engineCoolantTemperatureMilliC", "engineImmobilizer", "engineLoadPercent", "engineOilPressureKPa", "engineRpm", "engineStates", "faultCodes", "fuelPercents", "gps", "gpsDistanceMeters", "intakeManifoldTemperatureMilliC", "nfcCardScans", "obdEngineSeconds", "obdOdometerMeters", "spreaderLiquidRate", "spreaderGranularRate", "spreaderPrewetRate", "spreaderAirTemp", "spreaderRoadTemp", "spreaderOnState", "spreaderActive", "spreaderBlastState", "spreaderGranularName", "spreaderPrewetName", "spreaderLiquidName", "spreaderPlowStatus", "seatbeltDriver" ], "type": "string" }, "type": "array" }, "style": "form" }, "driverActivationStatusParam": { "description": "If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers).", "in": "query", "name": "driverActivationStatus", "schema": { "enum": [ "active", "deactivated" ], "type": "string" } }, "equipmentStatTypes": { "description": "The types of equipment stats you want to query. Currently, you may submit up to 3 types.\r\n\r\n- `engineRpm`: The revolutions per minute of the engine.\r\n- `fuelPercents`: The percent of fuel in the unit of equipment.\r\n- `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics.\r\n- `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: \r\n - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) \r\n - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). \r\n- `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard.\r\n- `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`.\r\n- `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`.\r\n- `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`.\r\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. \r\n- `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling.", "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "gatewayEngineStates", "obdEngineStates", "fuelPercents", "engineRpm", "gatewayEngineSeconds", "obdEngineSeconds", "gatewayJ1939EngineSeconds", "gpsOdometerMeters", "gps", "engineTotalIdleTimeMinutes" ], "format": "string", "type": "string" }, "type": "array" }, "style": "form" }, "isDeactivatedParam": { "description": "If value is true, only drivers that are deactivated will appear in the response. This parameter will default to false if not provided (fetching only active drivers).", "in": "query", "name": "isDeactivated", "schema": { "type": "boolean" } }, "vehicleStatTypes": { "description": "The stat types you want this endpoint to return information on. See also the \u003Ca href=\"/docs/telematics#query-parameters\" target=\"_blank\"\u003ETelematics\u003C/a\u003E guide for more details.\n\nYou may list ***up to 3*** types using comma-separated format. For example: `types=gps,engineStates,obdOdometerMeters`.\n\n*Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3. For example, you could list `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3` and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still count as their own individual types.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary inputs\u003C/a\u003E for the vehicle.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use \u003Ca href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\"\u003EGet engine immobilizer states\u003C/a\u003E to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD odometer cannot be pulled automatically. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading\" target=\"_blank\"\u003Ecloud dasbhoard\u003C/a\u003E. Odometer readings that are manually set will update as GPS trip data is gathered. Try combining with `obdOdometerMeters`.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted. Try combining with `gpsOdometerMeters`. \n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast mode’.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)", "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "ambientAirTemperatureMilliC", "auxInput1", "auxInput2", "auxInput3", "auxInput4", "auxInput5", "auxInput6", "auxInput7", "auxInput8", "auxInput9", "auxInput10", "auxInput11", "auxInput12", "auxInput13", "barometricPressurePa", "batteryMilliVolts", "defLevelMilliPercent", "ecuSpeedMph", "engineCoolantTemperatureMilliC", "engineImmobilizer", "engineLoadPercent", "engineOilPressureKPa", "engineRpm", "engineStates", "faultCodes", "fuelPercents", "gps", "gpsDistanceMeters", "gpsOdometerMeters", "intakeManifoldTemperatureMilliC", "nfcCardScans", "obdEngineSeconds", "obdOdometerMeters", "syntheticEngineSeconds", "evStateOfChargeMilliPercent", "evChargingStatus", "evChargingEnergyMicroWh", "evChargingVoltageMilliVolt", "evChargingCurrentMilliAmp", "evConsumedEnergyMicroWh", "evRegeneratedEnergyMicroWh", "evBatteryVoltageMilliVolt", "evBatteryCurrentMilliAmp", "evBatteryStateOfHealthMilliPercent", "evAverageBatteryTemperatureMilliCelsius", "evDistanceDrivenMeters", "spreaderLiquidRate", "spreaderGranularRate", "spreaderPrewetRate", "spreaderAirTemp", "spreaderRoadTemp", "spreaderOnState", "spreaderActive", "spreaderBlastState", "spreaderGranularName", "spreaderPrewetName", "spreaderLiquidName", "spreaderPlowStatus", "seatbeltDriver" ], "type": "string" }, "type": "array" }, "style": "form" } }, "requestBodies": { "V1DispatchRouteApplyToFutureRoutesParam": { "content": { "application/json": { "schema": { "properties": { "apply_to_future_routes": { "description": "This is only for a recurring route. If set to true, delete all following runs of the route. If set to false, only delete the current route.", "example": true, "type": "boolean" } }, "type": "object" } } }, "required": false }, "V1createDvirParam": { "content": { "application/json": { "schema": { "properties": { "inspectionType": { "description": "Only type 'mechanic' is currently accepted.", "enum": [ "mechanic" ], "example": "mechanic", "type": "string" }, "mechanicNotes": { "description": "Any notes from the mechanic.", "example": "Replaced headlight on passenger side.", "type": "string" }, "odometerMiles": { "description": "The current odometer of the vehicle.", "example": 38426, "type": "integer" }, "previousDefectsCorrected": { "description": "Whether any previous defects were corrected. If this vehicle or trailer was previously marked unsafe, and this DVIR marks it as safe, either previousDefectsCorrected or previousDefectsIgnored must be true.", "example": true, "type": "boolean" }, "previousDefectsIgnored": { "description": "Whether any previous defects were ignored. If this vehicle or trailer was previously marked unsafe, and this DVIR marks it as safe, either previousDefectsCorrected or previousDefectsIgnored must be true.", "example": false, "type": "boolean" }, "resolvedDefectIds": { "description": "List of defect IDs to resolve. The defects must be associated with the provided vehicle or trailer.", "example": [18, 19], "items": { "format": "int64", "type": "integer" }, "type": "array" }, "safe": { "description": "Whether or not this vehicle or trailer is safe to drive.", "enum": [ "safe", "unsafe" ], "example": "safe", "type": "string" }, "trailerId": { "description": "Id of trailer being inspected. Either vehicleId or trailerId must be provided.", "example": 11, "type": "integer" }, "userEmail": { "description": "The Samsara login email for the person creating the DVIR. The email must correspond to a Samsara user's email.", "example": "j.smith@yahoo.com", "type": "string" }, "vehicleId": { "description": "Id of vehicle being inspected. Either vehicleId or trailerId must be provided.", "example": 10, "type": "integer" } }, "required": [ "inspectionType", "safe", "userEmail" ], "type": "object" } } }, "description": "DVIR creation body", "required": true }, "V1createMessagesParam": { "content": { "application/json": { "schema": { "properties": { "driverIds": { "description": "IDs of the drivers for whom the messages are sent to.", "example": [111, 222, 333], "items": { "example": 555, "format": "int64", "type": "number" }, "type": "array" }, "text": { "description": "The text sent in the message. Max 2500 characters allowed.", "example": "This is a message.", "type": "string" } }, "required": [ "driverIds", "text" ], "type": "object" } } }, "description": "Text to send to a list of driverIds.", "required": true }, "V1documentCreateParam": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1DocumentCreate" } } }, "description": "To create a document for a given document type, provide the `documentTypeUuid` of the type of document you'd like to create. Then, pass in the `fields` of the document in the same order that they show up in the given document type.", "required": true }, "V1sensorParam": { "content": { "application/json": { "schema": { "properties": { "sensors": { "description": "List of sensor IDs to query.", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "sensors" ], "type": "object" } } }, "description": "List of sensor IDs to query.", "required": true }, "inline_object": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object" } } }, "required": false }, "inline_object_1": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_1" } } }, "required": false }, "inline_object_2": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_2" } } }, "required": true }, "inline_object_3": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_3" } } }, "required": true }, "inline_object_4": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_4" } } }, "required": true }, "inline_object_5": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_5" } } }, "required": true }, "inline_object_6": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_6" } } }, "required": true }, "inline_object_7": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_7" } } }, "required": true }, "inline_object_8": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_object_8" } } }, "required": true } }, "schemas": { "AccessoryResponseObjectResponseBody": { "description": "An object containing information about an accessory connected to the VG.", "properties": { "model": { "description": "Product model name of the device", "example": "EM11", "type": "string" }, "serial": { "description": "The serial number of the accessory device.", "example": "ABCD-123-EFG", "type": "string" } }, "type": "object" }, "ActionObjectRequestBody": { "description": "Action to take.", "properties": { "actionParams": { "$ref": "#/components/schemas/ActionParamsObjectRequestBody" }, "actionTypeId": { "description": "The id of the of the action type. Reference the following list for the ids:\nThe following action types are in Beta:\nDriver App Push = 5\nThe following action types are Stable:\nNotification (Email, Text, Samsara Fleet Push) = 1\nDashboard Notification = 3\nWebhook = 4\nSlack = 6\n", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "actionTypeId" ], "type": "object" }, "ActionObjectResponseBody": { "description": "Action to take.", "properties": { "actionParams": { "$ref": "#/components/schemas/ActionParamsObjectResponseBody" }, "actionTypeId": { "description": "The id of the of the action type. Reference the following list for the ids:\nThe following action types are in Beta:\nDriver App Push = 5\nThe following action types are Stable:\nNotification (Email, Text, Samsara Fleet Push) = 1\nDashboard Notification = 3\nWebhook = 4\nSlack = 6\n", "example": 1, "format": "int32", "type": "integer" } }, "required": [ "actionTypeId" ], "type": "object" }, "ActionParamsObjectRequestBody": { "description": "The action type specific details. Set webhookIds for Slack or Webhook actions. Set recipients for Notifications. Set driverAppNotification for Driver App Push. Other action types don't need to set a param.", "properties": { "driverAppNotification": { "$ref": "#/components/schemas/DriverAppNotificationObjectRequestBody" }, "recipients": { "description": "Recipient of the action.", "items": { "$ref": "#/components/schemas/RecipientObjectRequestBody" }, "type": "array" }, "webhooks": { "$ref": "#/components/schemas/WebhookParamsObjectRequestBody" } }, "type": "object" }, "ActionParamsObjectResponseBody": { "description": "The action type specific details. Set webhookIds for Slack or Webhook actions. Set recipients for Notifications. Set driverAppNotification for Driver App Push. Other action types don't need to set a param.", "properties": { "driverAppNotification": { "$ref": "#/components/schemas/DriverAppNotificationObjectResponseBody" }, "recipients": { "description": "Recipient of the action.", "items": { "$ref": "#/components/schemas/RecipientObjectResponseBody" }, "type": "array" }, "webhooks": { "$ref": "#/components/schemas/WebhookParamsObjectResponseBody" } }, "type": "object" }, "Address": { "description": "An Address object.", "properties": { "addressTypes": { "description": "Reporting location type associated with the address (used for ELD reporting purposes). Valid values: `yard`, `shortHaul`, `workforceSite`, `riskZone`, `industrialSite`, `alertsOnly`, `agricultureSource`.", "items": { "enum": [ "yard", "shortHaul", "workforceSite", "riskZone", "industrialSite", "alertsOnly", "agricultureSource" ], "example": "yard", "type": "string" }, "type": "array" }, "contacts": { "description": "An array Contact mini-objects that are associated the Address.", "items": { "$ref": "#/components/schemas/contactTinyResponse" }, "type": "array" }, "createdAtTime": { "description": "The date and time this address was created in RFC 3339 format.", "example": "2019-05-18T20:27:35Z", "format": "date-time", "type": "string" }, "externalIds": { "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "properties": { }, "type": "object" }, "formattedAddress": { "description": "The full street address for this address/geofence, as it might be recognized by Google Maps.", "example": "350 Rhode Island St, San Francisco, CA", "maxLength": 1024, "type": "string" }, "geofence": { "$ref": "#/components/schemas/AddressGeofence" }, "id": { "description": "ID of the Address.", "example": "22408", "type": "string" }, "latitude": { "description": "Latitude of the address. Will be geocoded from `formattedAddress` if not provided.", "example": 37.765363, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the address. Will be geocoded from `formattedAddress` if not provided.", "example": -122.4029238, "format": "double", "type": "number" }, "name": { "description": "Name of the address.", "example": "Samsara HQ", "maxLength": 255, "type": "string" }, "notes": { "description": "Notes about the address.", "example": "Hours of operation: 8am - 6pm; Truck entrance on the Rhode Island street side.", "maxLength": 280, "type": "string" }, "tags": { "description": "An array of all tag mini-objects that are associated with the given address entry.", "items": { "$ref": "#/components/schemas/tagTinyResponse" }, "type": "array" } }, "required": [ "formattedAddress", "geofence", "id", "name" ], "type": "object" }, "AddressGeofence": { "description": "The geofence that defines this address and its bounds. This can either be a circle or a polygon, but not both.", "properties": { "circle": { "$ref": "#/components/schemas/AddressGeofence_circle" }, "polygon": { "$ref": "#/components/schemas/AddressGeofence_polygon" }, "settings": { "$ref": "#/components/schemas/AddressGeofence_settings" } }, "type": "object" }, "AddressGeofence_circle": { "description": "Information about a circular geofence. This field is only needed if the geofence is a circle.", "properties": { "latitude": { "description": "Latitude of the address. Will be geocoded from `formattedAddress` if not provided.", "example": 37.765363, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the address. Will be geocoded from `formattedAddress` if not provided.", "example": -122.4029238, "format": "double", "type": "number" }, "radiusMeters": { "description": "The radius of the circular geofence in meters.", "example": 25, "format": "int64", "type": "integer" } }, "required": [ "radiusMeters" ], "type": "object" }, "AddressGeofence_polygon": { "description": "Information about a polygon geofence. This field is only needed if the geofence is a polygon.", "properties": { "vertices": { "description": "The vertices of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.", "example": [ { "latitude": 37.765363, "longitude": -122.403098 }, { "latitude": 38.765363, "longitude": -122.403098 }, { "latitude": 37.765363, "longitude": -123.403098 } ], "items": { "$ref": "#/components/schemas/AddressGeofence_polygon_vertices" }, "maxItems": 40, "minItems": 3, "type": "array" } }, "required": [ "vertices" ], "type": "object" }, "AddressGeofence_polygon_vertices": { "properties": { "latitude": { "description": "The latitude of a geofence vertex in decimal degrees.", "format": "double", "type": "number" }, "longitude": { "description": "The longitude of a geofence vertex in decimal degrees.", "format": "double", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "AddressGeofence_settings": { "description": "Information about a geofence's settings.", "properties": { "showAddresses": { "description": "If this property is set to true, then underlying geofence addresses will be shown in reports instead of a geofence's name.", "example": false, "type": "boolean" } }, "type": "object" }, "AddressResponse": { "description": "An Address response body.", "properties": { "data": { "$ref": "#/components/schemas/Address" } }, "required": [ "data" ], "type": "object" }, "AddressResponseResponseBody": { "description": "Closest address that the GPS latitude and longitude match to.", "properties": { "city": { "description": "The name of the city", "example": "New York", "type": "string" }, "country": { "description": "The country", "example": "USA", "type": "string" }, "neighborhood": { "description": "The name of the neighborhood if one exists", "example": "Mission District", "type": "string" }, "pointOfInterest": { "description": "Point that may be of interest to the user", "example": "The Eiffel Tower", "type": "string" }, "postalCode": { "description": "The zip code", "example": "10010", "type": "string" }, "state": { "description": "The name of the state", "example": "New York", "type": "string" }, "street": { "description": "The street name", "example": "Main Street", "type": "string" }, "streetNumber": { "description": "Street number of the address", "example": "16", "type": "string" } }, "type": "object" }, "AempEquipmentGetAempEquipmentListBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentGetAempEquipmentListBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentGetAempEquipmentListGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentGetAempEquipmentListInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentGetAempEquipmentListMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentGetAempEquipmentListNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentGetAempEquipmentListNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentGetAempEquipmentListResponseBody": { "properties": { "Fleet": { "$ref": "#/components/schemas/AempFleetListResponseBody" } }, "required": [ "Fleet" ], "type": "object" }, "AempEquipmentGetAempEquipmentListServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentGetAempEquipmentListTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentGetAempEquipmentListUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AempEquipmentWithAdditionalFieldsResponseBody": { "description": "Contains equipment fields.", "properties": { "CumulativeOperatingHours": { "$ref": "#/components/schemas/CumulativeOperatingHoursResponseBody" }, "DEFRemaining": { "$ref": "#/components/schemas/DEFRemainingResponseBody" }, "Distance": { "$ref": "#/components/schemas/DistanceResponseBody" }, "EngineStatus": { "$ref": "#/components/schemas/EngineStatusResponseBody" }, "EquipmentHeader": { "$ref": "#/components/schemas/EquipmentHeaderWithAdditionalFieldsResponseBody" }, "FuelRemaining": { "$ref": "#/components/schemas/FuelRemainingResponseBody" }, "Location": { "$ref": "#/components/schemas/LocationResponseBody" } }, "required": [ "EquipmentHeader", "Location" ], "type": "object" }, "AempFleetListResponseBody": { "description": "Contains a list of equipment objects and links", "properties": { "Equipment": { "description": "The list of Equipment objects.", "items": { "$ref": "#/components/schemas/AempEquipmentWithAdditionalFieldsResponseBody" }, "type": "array" }, "Links": { "description": "The list of links associated with the current API request.", "items": { "$ref": "#/components/schemas/AempLinkResponseBody" }, "type": "array" }, "snapshotTime": { "description": "Date and time at which the snapshot of the fleet was created in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "version": { "description": "The version of the ISO/TS 15143-3 standard", "example": "1", "type": "string" } }, "required": [ "Equipment", "Links", "snapshotTime", "version" ], "type": "object" }, "AempLinkResponseBody": { "description": "Contains a list of relevant links", "properties": { "href": { "description": "The hyperlink of the relationship.", "example": "https://api.samsara.com/aemp/Fleet/1", "type": "string" }, "rel": { "description": "The link relationship to the current call.", "example": "self", "type": "string" } }, "required": [ "href", "rel" ], "type": "object" }, "AlertsDeleteConfigurationsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsDeleteConfigurationsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsDeleteConfigurationsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsDeleteConfigurationsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsDeleteConfigurationsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsDeleteConfigurationsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsDeleteConfigurationsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsDeleteConfigurationsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsDeleteConfigurationsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsDeleteConfigurationsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsResponseBody": { "properties": { "data": { "description": "List of alert configurations.", "items": { "$ref": "#/components/schemas/GetResponseWorkflowConfigurationObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "AlertsGetConfigurationsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetConfigurationsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsResponseBody": { "properties": { "data": { "description": "List of workflow incidents.", "items": { "$ref": "#/components/schemas/GetWorkflowIncidentResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "AlertsGetIncidentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsGetIncidentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsRequestBody": { "description": "The configuration of a alert.", "properties": { "actions": { "description": "An array of actions.", "items": { "$ref": "#/components/schemas/ActionObjectRequestBody" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unqiue Samsara id of the alert configuration.", "example": "e1c5dffc-c7b7-47b0-a778-6a65de638abf", "type": "string" }, "isEnabled": { "description": "Whether the alert is enabled or not.", "example": true, "type": "boolean" }, "name": { "description": "The custom name of the configuration.", "example": "My Harsh Event Alert", "type": "string" }, "operationalSettings": { "$ref": "#/components/schemas/OperationalSettingsObjectRequestBody" }, "scope": { "$ref": "#/components/schemas/ScopeObjectRequestBody" }, "triggers": { "description": "An array of triggers.", "items": { "$ref": "#/components/schemas/WorkflowTriggerObjectRequestBody" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "AlertsPatchConfigurationsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PatchResponseWorkflowConfigurationObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "AlertsPatchConfigurationsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPatchConfigurationsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsRequestBody": { "description": "The configuration of a alert.", "properties": { "actions": { "description": "An array of actions.", "items": { "$ref": "#/components/schemas/ActionObjectRequestBody" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "isEnabled": { "default": true, "description": "Whether the alert is enabled or not.", "example": true, "type": "boolean" }, "name": { "description": "The custom name of the configuration.", "example": "My Harsh Event Alert", "type": "string" }, "operationalSettings": { "$ref": "#/components/schemas/OperationalSettingsObjectRequestBody" }, "scope": { "$ref": "#/components/schemas/ScopeObjectRequestBody" }, "triggers": { "description": "An array of triggers.", "items": { "$ref": "#/components/schemas/WorkflowTriggerObjectRequestBody" }, "type": "array" } }, "required": [ "actions", "isEnabled", "name", "scope", "triggers" ], "type": "object" }, "AlertsPostConfigurationsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PostResponseResWorkflowConfigurationObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "AlertsPostConfigurationsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AlertsPostConfigurationsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AmbientTemperatureDetailsObjectRequestBody": { "description": "Details specific to Ambient Temperature.", "properties": { "cargoIsFull": { "description": "Whether the cargo is full.", "example": true, "type": "boolean" }, "doorsAreClosed": { "description": "Whether the doors are closed.", "example": true, "type": "boolean" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `GREATER`, `INSIDE_RANGE`, `LESS`, `OUTSIDE_RANGE`", "enum": [ "GREATER", "INSIDE_RANGE", "LESS", "OUTSIDE_RANGE" ], "example": "GREATER", "type": "string" }, "temperatureCelcius": { "description": "The temperature in Celcius threshold value.", "example": 60, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds", "operation", "temperatureCelcius" ], "type": "object" }, "AmbientTemperatureDetailsObjectResponseBody": { "description": "Details specific to Ambient Temperature.", "properties": { "cargoIsFull": { "description": "Whether the cargo is full.", "example": true, "type": "boolean" }, "doorsAreClosed": { "description": "Whether the doors are closed.", "example": true, "type": "boolean" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `GREATER`, `INSIDE_RANGE`, `LESS`, `OUTSIDE_RANGE`", "enum": [ "GREATER", "INSIDE_RANGE", "LESS", "OUTSIDE_RANGE" ], "example": "GREATER", "type": "string" }, "temperatureCelcius": { "description": "The temperature in Celcius threshold value.", "example": 60, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds", "operation", "temperatureCelcius" ], "type": "object" }, "AmbientTemperatureResponseBody": { "description": "Details specific to Ambient Temperature.", "properties": { "sensor": { "$ref": "#/components/schemas/alertObjectSensorResponseBody" } }, "type": "object" }, "AnticipationBrakeEventCount": { "description": "Quick braking events (less than one second after accelerating).", "type": "number" }, "AssetCreate": { "description": "The asset creation arguments", "properties": { "customMetadata": { "$ref": "#/components/schemas/CustomMetadata" }, "location": { "$ref": "#/components/schemas/AssetLocation" }, "locationDataInputId": { "description": "Required if locationType is \"dataInput\". Specifies the id of a location data input which will determine the asset's location. **The data input will be moved to the new asset.**", "example": "12345", "type": "string" }, "locationType": { "$ref": "#/components/schemas/LocationType" }, "name": { "$ref": "#/components/schemas/AssetName" }, "parentId": { "$ref": "#/components/schemas/ParentId" }, "runningStatusDataInputId": { "description": "The asset's isRunning status will be true when the associated data input's value is 1. Data input cannot be of location format. **The data input will be moved to the new asset.**", "example": "67890", "type": "string" }, "tagIds": { "$ref": "#/components/schemas/TagIds" } }, "required": [ "name" ], "type": "object" }, "AssetDataInput": { "properties": { "dataGroup": { "description": "Name of the data group that the data input is associated with", "example": "Pressure", "type": "string" }, "id": { "description": "ID of the data input", "example": "123456", "type": "string" }, "lastPoint": { "$ref": "#/components/schemas/AssetDataInput_lastPoint" }, "name": { "description": "Name of the data input", "example": "Digital Input 1", "type": "string" }, "units": { "description": "Units of data for this data input", "example": "PSI", "type": "string" } }, "type": "object" }, "AssetDataInput_lastPoint": { "description": "The last reported point of a data input.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Numeric value of the data point.", "example": 1992.0506, "format": "double", "type": "number" } }, "type": "object" }, "AssetDataOutput": { "properties": { "dataGroup": { "description": "Name of the data group that the data output is associated with", "example": "Control Pressure", "type": "string" }, "dataInput": { "$ref": "#/components/schemas/AssetDataInput" }, "deviceId": { "description": "ID of the device that the data output is configured on", "example": "123", "type": "string" }, "id": { "description": "ID of the data output", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "string" }, "name": { "description": "Name of the data output", "example": "Digital Output 1", "type": "string" } }, "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsRequestBody": { "properties": { "values": { "description": "A map of data output IDs to values. All data outputs must belong to the same asset. Only the specified IDs will be written to.", "example": "", "type": "object" } }, "required": [ "values" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsResponseBody": { "properties": { "data": { "description": "List of responses for each data output from the original request.", "items": { "$ref": "#/components/schemas/PatchAssetDataOutputsSingleResponseResponseBody" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetDataOutputsPatchAssetDataOutputsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetLocation": { "description": "For locationType \"point\", latitude and longitude are required. For \"address\", formattedAddress must be provided, and lat/long can be optionally included for displaying a dot on the assets map. For \"dataInput\", this object should not be passed in.", "properties": { "formattedAddress": { "description": "Formatted address of the location", "example": "350 Rhode Island St, San Francisco CA, 94103", "type": "string" }, "latitude": { "$ref": "#/components/schemas/latitude" }, "longitude": { "$ref": "#/components/schemas/longitude" } }, "type": "object" }, "AssetLocationHeading": { "description": "Heading of the asset in degrees.", "example": 120, "format": "double", "type": "number" }, "AssetLocationSpeed": { "description": "GPS speed of the asset in miles per hour.", "example": 48.3, "format": "double", "type": "number" }, "AssetName": { "description": "The name of the asset.", "type": "string" }, "AssetPatch": { "description": "The asset creation arguments", "properties": { "customMetadata": { "$ref": "#/components/schemas/CustomMetadata" }, "location": { "$ref": "#/components/schemas/AssetLocation" }, "locationDataInputId": { "description": "Required if locationType is \"dataInput\". Specifies the id of a location data input which will determine the asset's location. The data input must be in the asset.", "example": "12345", "type": "string" }, "locationType": { "$ref": "#/components/schemas/LocationType" }, "name": { "$ref": "#/components/schemas/AssetName" }, "parentId": { "description": "The id of the parent asset that the asset belongs to. Pass in an empty string to remove the child from the parent.", "example": "", "type": "string" }, "runningStatusDataInputId": { "description": "The asset's isRunning status will be true when the associated data input's value is 1. Data input cannot be of location format. The data input must be in the asset.", "example": "67890", "type": "string" }, "tagIds": { "$ref": "#/components/schemas/TagIds" } }, "type": "object" }, "AssetResponse": { "description": "Asset", "properties": { "customMetadata": { "$ref": "#/components/schemas/CustomMetadata" }, "dataOutputs": { "description": "The list of data outputs configured on the asset.", "items": { "$ref": "#/components/schemas/AssetDataOutput" }, "type": "array" }, "id": { "description": "The id of the asset", "example": "123abcde-4567-8910-1112-fghi1314jklm", "type": "string" }, "isRunning": { "description": "The running status of the asset. Returns True for On, and False for Off.", "type": "boolean" }, "location": { "$ref": "#/components/schemas/AssetLocation" }, "locationDataInput": { "$ref": "#/components/schemas/AssetResponse_locationDataInput" }, "locationType": { "$ref": "#/components/schemas/LocationType" }, "name": { "$ref": "#/components/schemas/AssetName" }, "parentAsset": { "$ref": "#/components/schemas/AssetResponse_parentAsset" }, "runningStatusDataInput": { "$ref": "#/components/schemas/AssetResponse_runningStatusDataInput" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Industrial Asset. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.", "items": { "$ref": "#/components/schemas/tagTinyResponse" }, "type": "array" } }, "required": [ "id", "isRunning", "name" ], "type": "object" }, "AssetResponseBody": { "description": "Representation of a vehicle trailer or other equipment to be tracked.", "properties": { "createdAtTime": { "description": "The time the asset was created in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unique ID of the asset.", "example": "12345", "type": "string" }, "licensePlate": { "description": "The license plate of the asset.", "example": "XHK1234", "type": "string" }, "make": { "description": "The OEM/manufacturer of the asset. Updates to this field are restricted.", "example": "Bobcat", "type": "string" }, "model": { "description": "The model of the asset. Updates to this field are restricted.", "example": "S630 T4", "type": "string" }, "name": { "description": "The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "MyAsset-1234", "type": "string" }, "notes": { "description": "These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are notes.", "type": "string" }, "regulationMode": { "description": "Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`", "enum": [ "mixed", "regulated", "unregulated" ], "example": "mixed", "type": "string" }, "serialNumber": { "description": "The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths.", "example": "LN016251", "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Asset.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" }, "type": { "default": "uncategorized", "description": "The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "trailer", "type": "string" }, "updatedAtTime": { "description": "The time the asset was last updated in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "vin": { "description": "The unique 17-digit VIN (Vehicle Identification Number) or PIN (Product Identification Number) of the asset.", "example": "1FUJBBCKXCLBZ1234", "type": "string" }, "year": { "description": "The model year of the asset. Updates to this field are restricted.", "example": 2015, "format": "int64", "type": "integer" } }, "required": [ "createdAtTime", "id", "updatedAtTime" ], "type": "object" }, "AssetResponseResponseBody": { "description": "Asset that the location readings are tied to.", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the asset", "example": "12345", "type": "string" } }, "required": [ "id" ], "type": "object" }, "AssetResponse_locationDataInput": { "description": "The associated location data input (only applicable when locationType is \"dataInput\").", "properties": { "id": { "description": "Id of the data input", "type": "string" } }, "required": [ "id" ], "type": "object" }, "AssetResponse_parentAsset": { "description": "The asset's parent", "properties": { "id": { "$ref": "#/components/schemas/ParentId" }, "name": { "$ref": "#/components/schemas/AssetName" } }, "required": [ "id", "name" ], "type": "object" }, "AssetResponse_runningStatusDataInput": { "description": "The associated running status data input. isRunning will be true when the data input's value is 1.", "properties": { "id": { "description": "Id of the data input", "example": "12345", "type": "string" } }, "required": [ "id" ], "type": "object" }, "AssetsCreateAssetBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsCreateAssetBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsCreateAssetGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsCreateAssetInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsCreateAssetMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsCreateAssetNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsCreateAssetNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsCreateAssetRequestBody": { "description": "Representation of a vehicle trailer or other equipment to be tracked.", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "licensePlate": { "description": "The license plate of the asset.", "example": "XHK1234", "type": "string" }, "make": { "description": "The OEM/manufacturer of the asset. Updates to this field are restricted.", "example": "Bobcat", "type": "string" }, "model": { "description": "The model of the asset. Updates to this field are restricted.", "example": "S630 T4", "type": "string" }, "name": { "description": "The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "MyAsset-1234", "type": "string" }, "notes": { "description": "These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are notes.", "type": "string" }, "regulationMode": { "description": "Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`", "enum": [ "mixed", "regulated", "unregulated" ], "example": "mixed", "type": "string" }, "serialNumber": { "description": "The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths.", "example": "LN016251", "type": "string" }, "type": { "default": "uncategorized", "description": "The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "trailer", "type": "string" }, "vin": { "description": "The unique 17-digit VIN (Vehicle Identification Number) or PIN (Product Identification Number) of the asset.", "example": "1FUJBBCKXCLBZ1234", "type": "string" }, "year": { "description": "The model year of the asset. Updates to this field are restricted.", "example": 2015, "format": "int64", "type": "integer" } }, "type": "object" }, "AssetsCreateAssetResponseBody": { "properties": { "createdAtTime": { "description": "The time the asset was created in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unique ID of the asset.", "example": "12345", "type": "string" }, "licensePlate": { "description": "The license plate of the asset.", "example": "XHK1234", "type": "string" }, "make": { "description": "The OEM/manufacturer of the asset. Updates to this field are restricted.", "example": "Bobcat", "type": "string" }, "model": { "description": "The model of the asset. Updates to this field are restricted.", "example": "S630 T4", "type": "string" }, "name": { "description": "The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "MyAsset-1234", "type": "string" }, "notes": { "description": "These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are notes.", "type": "string" }, "regulationMode": { "description": "Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`", "enum": [ "mixed", "regulated", "unregulated" ], "example": "mixed", "type": "string" }, "serialNumber": { "description": "The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths.", "example": "LN016251", "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Asset.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" }, "type": { "default": "uncategorized", "description": "The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "trailer", "type": "string" }, "updatedAtTime": { "description": "The time the asset was last updated in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "vin": { "description": "The unique 17-digit VIN (Vehicle Identification Number) or PIN (Product Identification Number) of the asset.", "example": "1FUJBBCKXCLBZ1234", "type": "string" }, "year": { "description": "The model year of the asset. Updates to this field are restricted.", "example": 2015, "format": "int64", "type": "integer" } }, "required": [ "createdAtTime", "id", "updatedAtTime" ], "type": "object" }, "AssetsCreateAssetServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsCreateAssetTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsCreateAssetUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsDeleteAssetUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsAssetResponseResponseBody": { "description": "Asset that the input data is from.", "properties": { "attributes": { "description": "List of attributes associated with the entity", "items": { "$ref": "#/components/schemas/GoaAttributeTinyResponseBody" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the asset", "example": "12345", "type": "string" }, "tags": { "description": "The array of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Asset.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "AssetsInputsGetAssetsInputsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsGetAssetsInputsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsGetAssetsInputsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsGetAssetsInputsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsGetAssetsInputsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsGetAssetsInputsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsGetAssetsInputsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsGetAssetsInputsResponseBody": { "properties": { "data": { "description": "Array of assets inputs objects.", "items": { "$ref": "#/components/schemas/assetsInputsResponseResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "AssetsInputsGetAssetsInputsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsGetAssetsInputsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsInputsGetAssetsInputsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsResponseBody": { "properties": { "data": { "description": "List of assets", "items": { "$ref": "#/components/schemas/AssetResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "AssetsListAssetsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsListAssetsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsLocationLinkConfigAddressDetailsObject": { "description": "Location object that indicates what address information (destination point and/or ETA) will be shown by Live Sharing Link.", "properties": { "formattedAddress": { "description": "Formatted address of a location", "example": "1990 Alameda Street, San Francisco, CA 94103", "type": "string" }, "latitude": { "description": "Latitude of a location", "example": 37.456345, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of a location", "example": 34.5633749, "format": "double", "type": "number" }, "name": { "description": "Name of a location", "example": "Suburbs", "type": "string" } }, "required": [ "formattedAddress", "latitude", "longitude", "name" ], "type": "object" }, "AssetsLocationLinkConfigAddressDetailsObjectResponseBody": { "description": "Location object that indicates what address information (destination point and/or ETA) will be shown by Live Sharing Link.", "properties": { "formattedAddress": { "description": "Formatted address of a location", "example": "1990 Alameda Street, San Francisco, CA 94103", "type": "string" }, "latitude": { "description": "Latitude of a location", "example": 37.456345, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of a location", "example": 34.5633749, "format": "double", "type": "number" }, "name": { "description": "Name of a location", "example": "Suburbs", "type": "string" } }, "required": [ "formattedAddress", "latitude", "longitude", "name" ], "type": "object" }, "AssetsLocationLinkConfigObject": { "description": "Configuration details specific to the 'By Asset' Live Sharing Link.", "properties": { "assetId": { "description": "Unique assets ID that Live Sharing Link will show.", "example": "1234", "type": "string" }, "location": { "$ref": "#/components/schemas/AssetsLocationLinkConfigAddressDetailsObject" } }, "required": [ "assetId" ], "type": "object" }, "AssetsLocationLinkConfigObjectResponseBody": { "description": "Configuration details specific to the 'By Asset' Live Sharing Link.", "properties": { "assetId": { "description": "Unique assets ID that Live Sharing Link will show.", "example": "1234", "type": "string" }, "location": { "$ref": "#/components/schemas/AssetsLocationLinkConfigAddressDetailsObjectResponseBody" } }, "required": [ "assetId" ], "type": "object" }, "AssetsNearLocationLinkConfigObject": { "description": "Configuration details specific to the 'By Location' Live Sharing Link.", "properties": { "addressId": { "description": "ID of the address. Can be either a unique Samsara ID or an external ID for the address.", "example": "1234", "type": "string" } }, "required": [ "addressId" ], "type": "object" }, "AssetsNearLocationLinkConfigObjectResponseBody": { "description": "Configuration details specific to the 'By Location' Live Sharing Link.", "properties": { "addressId": { "description": "ID of the address. Can be either a unique Samsara ID or an external ID for the address.", "example": "1234", "type": "string" } }, "required": [ "addressId" ], "type": "object" }, "AssetsOnRouteLinkConfigObject": { "description": "Configuration details specific to the 'By Recurring Route' Live Sharing Link.", "properties": { "recurringRouteId": { "description": "Samsara ID of the recurring route.", "example": "1234", "type": "string" } }, "required": [ "recurringRouteId" ], "type": "object" }, "AssetsOnRouteLinkConfigObjectResponseBody": { "description": "Configuration details specific to the 'By Recurring Route' Live Sharing Link.", "properties": { "recurringRouteId": { "description": "Samsara ID of the recurring route.", "example": "1234", "type": "string" } }, "required": [ "recurringRouteId" ], "type": "object" }, "AssetsUpdateAssetBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsUpdateAssetBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsUpdateAssetGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsUpdateAssetInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsUpdateAssetMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsUpdateAssetNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsUpdateAssetNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsUpdateAssetRequestBody": { "description": "Representation of a vehicle trailer or other equipment to be tracked.", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "licensePlate": { "description": "The license plate of the asset.", "example": "XHK1234", "type": "string" }, "make": { "description": "The OEM/manufacturer of the asset. Updates to this field are restricted.", "example": "Bobcat", "type": "string" }, "model": { "description": "The model of the asset. Updates to this field are restricted.", "example": "S630 T4", "type": "string" }, "name": { "description": "The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "MyAsset-1234", "type": "string" }, "notes": { "description": "These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are notes.", "type": "string" }, "regulationMode": { "description": "Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`", "enum": [ "mixed", "regulated", "unregulated" ], "example": "mixed", "type": "string" }, "serialNumber": { "description": "The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths.", "example": "LN016251", "type": "string" }, "type": { "description": "The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "trailer", "type": "string" }, "vin": { "description": "The unique 17-digit VIN (Vehicle Identification Number) or PIN (Product Identification Number) of the asset.", "example": "1FUJBBCKXCLBZ1234", "type": "string" }, "year": { "description": "The model year of the asset. Updates to this field are restricted.", "example": 2015, "format": "int64", "type": "integer" } }, "type": "object" }, "AssetsUpdateAssetResponseBody": { "properties": { "createdAtTime": { "description": "The time the asset was created in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unique ID of the asset.", "example": "12345", "type": "string" }, "licensePlate": { "description": "The license plate of the asset.", "example": "XHK1234", "type": "string" }, "make": { "description": "The OEM/manufacturer of the asset. Updates to this field are restricted.", "example": "Bobcat", "type": "string" }, "model": { "description": "The model of the asset. Updates to this field are restricted.", "example": "S630 T4", "type": "string" }, "name": { "description": "The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "MyAsset-1234", "type": "string" }, "notes": { "description": "These are generic notes about the asset. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are notes.", "type": "string" }, "regulationMode": { "description": "Whether or not the asset is regulated, unregulated (non-CMV), or a mixed use unregulated asset. Primarily used with vehicles. Valid values: `mixed`, `regulated`, `unregulated`", "enum": [ "mixed", "regulated", "unregulated" ], "example": "mixed", "type": "string" }, "serialNumber": { "description": "The serial number of the asset. This can be an internal serial number or used to hold legacy VIN/PIN numbers such as ones of shorter lengths.", "example": "LN016251", "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Asset.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" }, "type": { "default": "uncategorized", "description": "The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "trailer", "type": "string" }, "updatedAtTime": { "description": "The time the asset was last updated in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "vin": { "description": "The unique 17-digit VIN (Vehicle Identification Number) or PIN (Product Identification Number) of the asset.", "example": "1FUJBBCKXCLBZ1234", "type": "string" }, "year": { "description": "The model year of the asset. Updates to this field are restricted.", "example": 2015, "format": "int64", "type": "integer" } }, "required": [ "createdAtTime", "id", "updatedAtTime" ], "type": "object" }, "AssetsUpdateAssetServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsUpdateAssetTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "AssetsUpdateAssetUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "Attribute": { "properties": { "attributeType": { "default": "string", "description": "Denotes the data type of the attribute's values. Valid values: `string`, `number`.", "enum": [ "string", "number" ], "example": "string", "type": "string" }, "attributeValueQuantity": { "default": "multi", "description": "Defines whether or not this attribute can be used on the same entity many times (with different values). Valid values: `single`, `multi`.", "enum": [ "single", "multi" ], "example": "multi", "type": "string" }, "entityType": { "description": "Denotes the type of entity, driver or asset. Valid values: `driver`, `asset`.", "enum": [ "driver", "asset" ], "example": "asset", "type": "string" }, "id": { "description": "The samsara id of the attribute object.", "example": "123e4567-e89b-12d3-a456-426614174000", "type": "string" }, "name": { "description": "Name of attribute.", "example": "License Certifications", "type": "string" }, "numberValues": { "description": "Number values that can be associated with this attribute", "items": { "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "String values that can be associated with this attribute", "items": { "type": "string" }, "type": "array" }, "values": { "description": "Representation of values that includes ids.", "items": { "$ref": "#/components/schemas/attributeValueTiny" }, "type": "array" } }, "type": "object" }, "AttributeEntity": { "properties": { "entityId": { "format": "int64", "type": "integer" }, "externalIds": { "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "properties": { }, "type": "object" }, "name": { "type": "string" }, "numberValues": { "description": "Number values that are associated with this attribute.", "items": { "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "String values that are associated with this attribute.", "items": { "type": "string" }, "type": "array" }, "values": { "description": "Representation of values that includes ids.", "items": { "$ref": "#/components/schemas/attributeValueTiny" }, "type": "array" } }, "type": "object" }, "AttributeExpanded": { "allOf": [ { "$ref": "#/components/schemas/Attribute" }, { "$ref": "#/components/schemas/AttributeExpanded_allOf" } ] }, "AttributeExpandedResponse": { "properties": { "data": { "$ref": "#/components/schemas/AttributeExpanded" } }, "type": "object" }, "AttributeExpanded_allOf": { "properties": { "entities": { "description": "Entities that this attribute is applied onto", "items": { "$ref": "#/components/schemas/AttributeEntity" }, "type": "array" } }, "required": [ "entities" ], "type": "object" }, "AttributeResponse": { "properties": { "data": { "$ref": "#/components/schemas/Attribute" } }, "type": "object" }, "AuthorSignatureObjectResponseBody": { "description": "An author signature for DVIRs with a signed time.", "properties": { "signatoryUser": { "$ref": "#/components/schemas/SignatoryUserObjectResponseBody" }, "signedAtTime": { "description": "The time when the DVIR was signed. UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "type": { "description": "Whether the DVIR was submitted by a driver or mechanic. Valid values: `driver`, `mechanic`", "enum": [ "driver", "mechanic" ], "example": "driver", "type": "string" } }, "required": [ "signatoryUser", "signedAtTime", "type" ], "type": "object" }, "CameraConnectorDisconectedResponseBody": { "description": "Details specific to Camera Connector Disconnected.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "CameraDetailsResponseResponseBody": { "description": "Camera-specific health metadata details.", "properties": { "gatewayLastConnectedTime": { "description": "The timestamp when the gateway was last connected to the vehicle, in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "lastFiftyHoursUptimePercentage": { "description": "The percentage of successful recording time during the time when the vehicle is on an active trip over the past 50 hours, in percentage points.", "example": 95.5, "format": "double", "type": "number" }, "vehicleGatewaySerial": { "description": "The serial number of the vehicle gateway that the camera is connected to.", "example": "VG-1234-5678", "type": "string" } }, "type": "object" }, "CameraSerial": { "description": "The serial number of the camera installed in the vehicle", "example": "CNCK-VT8-XA8", "type": "string" }, "CameraStreamIssueResponseBody": { "description": "Details specific to Camera Stream Issue.", "properties": { "cameraDevice": { "$ref": "#/components/schemas/alertObjectWorkforceCameraDeviceResponseBody" } }, "type": "object" }, "CarrierProposedAssignment": { "description": "A carrier proposed assignment object", "properties": { "acceptedTime": { "$ref": "#/components/schemas/CarrierProposedAssignmentAcceptedTime" }, "activeTime": { "$ref": "#/components/schemas/CarrierProposedAssignmentActiveTime" }, "driver": { "$ref": "#/components/schemas/CarrierProposedAssignmentDriver" }, "firstSeenTime": { "$ref": "#/components/schemas/CarrierProposedAssignmentFirstSeenTime" }, "id": { "$ref": "#/components/schemas/CarrierProposedAssignmentId" }, "rejectedTime": { "$ref": "#/components/schemas/CarrierProposedAssignmentRejectedTime" }, "shippingDocs": { "$ref": "#/components/schemas/CarrierProposedAssignmentShippingDocs" }, "trailers": { "$ref": "#/components/schemas/CarrierProposedAssignmentTrailers" }, "vehicle": { "$ref": "#/components/schemas/CarrierProposedAssignmentVehicle" } }, "required": [ "activeTime", "id" ], "type": "object" }, "CarrierProposedAssignmentAcceptedTime": { "description": "Time when the driver accepted this assignment in the mobile app. Will be omitted if the driver hasn't accepted this assignment. RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2020-01-27T07:06:25Z", "type": "string" }, "CarrierProposedAssignmentActiveTime": { "description": "Time after which this assignment will be active and visible to the driver on the mobile app. Not setting it makes it active now. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "CarrierProposedAssignmentDriver": { "allOf": [ { "description": "The driver that this assignment is for.", "type": "object" }, { "$ref": "#/components/schemas/driverTinyResponse" }, { "$ref": "#/components/schemas/CarrierProposedAssignmentDriver_allOf" } ] }, "CarrierProposedAssignmentDriverId": { "description": "Samsara ID for the driver that this assignment is for.", "example": "42", "type": "string" }, "CarrierProposedAssignmentDriver_allOf": { "properties": { "externalIds": { "$ref": "#/components/schemas/carrierProposedAssignmentDriverAllOf2ExternalIds" } }, "type": "object" }, "CarrierProposedAssignmentFirstSeenTime": { "description": "Time when the driver first saw this assignment in the mobile app. Will be omitted if the driver hasn't seen this assignment yet. RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2020-01-27T07:06:25Z", "type": "string" }, "CarrierProposedAssignmentId": { "description": "Samsara ID for the assignment.", "example": "08b3aeada5f4ab3010c0b4efa28d2d1890dbf8d48d2d", "type": "string" }, "CarrierProposedAssignmentRejectedTime": { "description": "Time when the driver rejected this assignment in the mobile app. Will be omitted if the driver hasn't rejected this assignment. RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2020-01-27T07:06:25Z", "type": "string" }, "CarrierProposedAssignmentResponse": { "description": "A carrier-proposed assignment response object.", "properties": { "data": { "$ref": "#/components/schemas/CarrierProposedAssignment" } }, "required": [ "data" ], "type": "object" }, "CarrierProposedAssignmentShippingDocs": { "description": "Shipping Documents that this assignment will propose to the driver.", "example": "Delivery 123, chips and soda", "maxLength": 40, "type": "string" }, "CarrierProposedAssignmentTrailer": { "allOf": [ { "description": "Trailer that this assignment will propose to the driver.", "type": "object" }, { "$ref": "#/components/schemas/trailerTinyResponse" }, { "$ref": "#/components/schemas/CarrierProposedAssignmentDriver_allOf" } ] }, "CarrierProposedAssignmentTrailerNames": { "description": "Names of trailers to propose.", "example": [ "Trailer123", "TrailerABC" ], "items": { "type": "string" }, "type": "array" }, "CarrierProposedAssignmentTrailers": { "description": "Trailers that this assignment will propose to the driver.", "items": { "$ref": "#/components/schemas/CarrierProposedAssignmentTrailer" }, "type": "array" }, "CarrierProposedAssignmentVehicle": { "allOf": [ { "description": "Vehicle that this assignment will propose to the driver.", "type": "object" }, { "$ref": "#/components/schemas/vehicleTinyResponse" } ] }, "CarrierProposedAssignmentVehicleId": { "description": "Samsara ID for the vehicle to propose.", "example": "123", "type": "string" }, "CellConnectivityResponseResponseBody": { "description": "Gateway cellular connectivity information.", "properties": { "operator": { "description": "The cellular network provider name.", "example": "AT&T", "type": "string" }, "signalBar": { "description": "The cellular signal strength indicator. Valid values: `1/4`, `2/4`, `3/4`, `4/4`, `unknown`", "enum": [ "1/4", "2/4", "3/4", "4/4", "unknown" ], "example": "1/4", "type": "string" } }, "type": "object" }, "CellSignalLossDetailsObjectRequestBody": { "description": "Details specific to Cell Signal Loss", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "CellSignalLossDetailsObjectResponseBody": { "description": "Details specific to Cell Signal Loss", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "CellSignalLossResponseBody": { "description": "Details specific to Cell Signal Loss.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "CircleRequestBody": { "description": "Information about a circular geofence. This field is only needed if the geofence is a circle.", "properties": { "latitude": { "description": "Latitude of the address. Will be geocoded from formattedAddress if not provided.", "example": 37.7749, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the address. Will be geocoded from formattedAddress if not provided.", "example": 137.7749, "format": "double", "type": "number" }, "name": { "description": "The name of the cirlce.", "example": "My Geofence Cirlce", "type": "string" }, "radiusMeters": { "description": "The radius of the circular geofence in meters.", "example": 23, "format": "int64", "type": "integer" } }, "required": [ "name", "radiusMeters" ], "type": "object" }, "CircleResponseBody": { "description": "Information about a circular geofence. This field is only needed if the geofence is a circle.", "properties": { "latitude": { "description": "Latitude of the address. Will be geocoded from formattedAddress if not provided.", "example": 37.7749, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the address. Will be geocoded from formattedAddress if not provided.", "example": 137.7749, "format": "double", "type": "number" }, "name": { "description": "The name of the cirlce.", "example": "My Geofence Cirlce", "type": "string" }, "radiusMeters": { "description": "The radius of the circular geofence in meters.", "example": 23, "format": "int64", "type": "integer" } }, "required": [ "name", "radiusMeters" ], "type": "object" }, "CloudBackupUploadIssueResponseBody": { "description": "Details specific to Cloud Backup Upload Issue.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "CoachAssignmentWithDriverExternalIdsResponseResponseBody": { "description": "Driver coach assignment object.", "properties": { "coachId": { "description": "Coach ID associated with coach assignment. Always returned.", "example": "45646", "type": "string" }, "createdAtTime": { "description": "Time coach assignment was created in UTC. Always returned.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "driver": { "$ref": "#/components/schemas/DriverWithExternalIdObjectResponseBody" }, "updatedAtTime": { "description": "Time coaching assignment was updated in UTC. Always returned.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "coachId", "createdAtTime", "driver", "updatedAtTime" ], "type": "object" }, "CoachAssignmentWithoutDriverExternalIdsResponseResponseBody": { "description": "Driver coach assignment object.", "properties": { "coachId": { "description": "Coach ID associated with coach assignment. Optional. Will be empty if no driver coach is assigned", "example": "45646", "type": "string" }, "createdAtTime": { "description": "Time coach assignment was created in UTC. Always returned.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "driverId": { "description": "Unique user ID for the driver of the driver coach assignment", "example": "45646", "type": "string" }, "updatedAtTime": { "description": "Time coaching assignment was updated in UTC. Always returned.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "createdAtTime", "driverId", "updatedAtTime" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsResponseBody": { "properties": { "data": { "description": "List of coaching sessions objects.", "items": { "$ref": "#/components/schemas/CoachingSessionsResponseResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsGetCoachingSessionsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CoachingSessionsResponseResponseBody": { "description": "List of coaching sessions objects.", "properties": { "assignedCoachId": { "description": "Unique user ID for a coaching session. Returned when a coaching session status is “incomplete”.", "example": "45646", "type": "string" }, "behaviors": { "description": "Object references for the behaviors within the session.", "items": { "$ref": "#/components/schemas/behaviorResponseBody" }, "type": "array" }, "coachingType": { "description": "Coaching type for the coaching session. Valid values: `fullySharedWithManager`, `selfCoaching`, `unknown`, `unshared`, `withManager`", "enum": [ "fullySharedWithManager", "selfCoaching", "unknown", "unshared", "withManager" ], "example": "unshared", "type": "string" }, "completedAtTime": { "description": "Time coaching session is completed in UTC. Returned when a coaching session status is “completed”.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "completedCoachId": { "description": "Unique user ID for a completed coaching session. Returned when a coaching session status is “completed”.", "example": "45646", "type": "string" }, "driver": { "$ref": "#/components/schemas/DriverWithExternalIdObjectResponseBody" }, "dueAtTime": { "description": "Time coaching session is due in UTC.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique ID for the coaching session.", "example": "f5271458-21f9-4a9f-a290-780c6d8840ff", "type": "string" }, "sessionNote": { "description": "Associated note for the coaching session. Returned when present.", "example": "Need to wear seatbelt even for short trips.", "type": "string" }, "sessionStatus": { "description": "Status for the coaching session. Valid values: `unknown`, `upcoming`, `completed`, `deleted`", "enum": [ "unknown", "upcoming", "completed", "deleted" ], "example": "completed", "type": "string" }, "updatedAtTime": { "description": "Time coaching session was updated in UTC.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "behaviors", "coachingType", "driver", "dueAtTime", "id", "sessionStatus", "updatedAtTime" ], "type": "object" }, "CoastingDurationMs": { "description": "Time spent without engaging the accelerator or brake in milliseconds.", "type": "number" }, "ConnectionStatusResponseObjectResponseBody": { "description": "An objecting containing information about the connectivity status of the gateway", "properties": { "healthStatus": { "description": "The most recent health status of the gateway. Valid values: `Status Not Set`, `Connected`, `Not Installed`, `Power Source Off - Active Vehicle`, `Power Source Off - Inactive Vehicle`, `Weak Cellular Signal`, `Requires Investigation`, `Requires Charge`, `Unsupported Product`, `Low Battery. Replace Device.`, `Low Vehicle Battery`, `Unplugged`, `Low Charging State`, `Vehicle Off`, `Weak GPS Signal`, `Low Gateway Battery`, `Low Gateway Battery (AG24)`, `Low Gateway Battery (AG45)`, `Low Gateway Battery (AG26)`, `Low Gateway Battery (AG46)`, `Low Gateway Battery (AG46-P)`, `Temporarily Offline`, `Prolonged Offline`, `Recently Offline`, `Replacement Required`, `Status Unknown`", "enum": [ "Status Not Set", "Connected", "Not Installed", "Power Source Off - Active Vehicle", "Power Source Off - Inactive Vehicle", "Weak Cellular Signal", "Requires Investigation", "Requires Charge", "Unsupported Product", "Low Battery. Replace Device.", "Low Vehicle Battery", "Unplugged", "Low Charging State", "Vehicle Off", "Weak GPS Signal", "Low Gateway Battery", "Low Gateway Battery (AG24)", "Low Gateway Battery (AG45)", "Low Gateway Battery (AG26)", "Low Gateway Battery (AG46)", "Low Gateway Battery (AG46-P)", "Temporarily Offline", "Prolonged Offline", "Recently Offline", "Replacement Required", "Status Unknown" ], "example": "Not Installed", "type": "string" }, "lastConnected": { "description": "The last time the gateway was connected in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "Contact": { "description": "Information about a notification contact for alerts.", "properties": { "email": { "$ref": "#/components/schemas/ContactEmail" }, "firstName": { "$ref": "#/components/schemas/ContactFirstName" }, "id": { "$ref": "#/components/schemas/ContactId" }, "lastName": { "$ref": "#/components/schemas/ContactLastName" }, "phone": { "$ref": "#/components/schemas/ContactPhone" } }, "required": [ "email", "firstName", "id", "lastName", "phone" ], "type": "object" }, "ContactEmail": { "description": "Email address of the contact.", "example": "jane.jones@yahoo.com", "maxLength": 255, "type": "string" }, "ContactFirstName": { "description": "First name of the contact.", "example": "Jane", "maxLength": 255, "type": "string" }, "ContactId": { "description": "ID of the contact.", "example": "22408", "type": "string" }, "ContactLastName": { "description": "Last name of the contact.", "example": "Jones", "maxLength": 255, "type": "string" }, "ContactPhone": { "description": "Phone number of the contact.", "example": "111-222-3344", "maxLength": 255, "type": "string" }, "ContactResponse": { "description": "A single contact.", "properties": { "data": { "$ref": "#/components/schemas/Contact" } }, "type": "object" }, "CreateAddressRequest": { "description": "A request body to create an Address.", "properties": { "addressTypes": { "description": "Reporting location type associated with the address (used for ELD reporting purposes). Valid values: `yard`, `shortHaul`, `workforceSite`, `riskZone`, `industrialSite`, `alertsOnly`, `agricultureSource`.", "items": { "enum": [ "yard", "shortHaul", "workforceSite", "riskZone", "industrialSite", "alertsOnly", "agricultureSource" ], "example": "yard", "type": "string" }, "type": "array" }, "contactIds": { "description": "An array of Contact IDs associated with this Address.", "items": { "example": "22408", "type": "string" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "formattedAddress": { "description": "The full street address for this address/geofence, as it might be recognized by Google Maps.", "example": "350 Rhode Island St, San Francisco, CA", "maxLength": 1024, "type": "string" }, "geofence": { "$ref": "#/components/schemas/CreateAddressRequest_geofence" }, "latitude": { "description": "Latitude of the address. Will be geocoded from `formattedAddress` if not provided.", "example": 37.765363, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the address. Will be geocoded from `formattedAddress` if not provided.", "example": -122.4029238, "format": "double", "type": "number" }, "name": { "description": "Name of the address.", "example": "Samsara HQ", "maxLength": 255, "type": "string" }, "notes": { "description": "Notes about the address.", "example": "Hours of operation: 8am - 6pm; Truck entrance on the Rhode Island street side.", "maxLength": 280, "type": "string" }, "tagIds": { "description": "An array of IDs of tags to associate with this address.", "items": { "example": "3914", "type": "string" }, "type": "array" } }, "required": [ "formattedAddress", "geofence", "name" ], "type": "object" }, "CreateAddressRequest_geofence": { "description": "The geofence that defines this address and its bounds. This can either be a circle or a polygon, but not both.", "properties": { "circle": { "$ref": "#/components/schemas/AddressGeofence_circle" }, "polygon": { "$ref": "#/components/schemas/AddressGeofence_polygon" }, "settings": { "$ref": "#/components/schemas/CreateAddressRequest_geofence_settings" } }, "type": "object" }, "CreateAddressRequest_geofence_settings": { "description": "Information about a geofence's settings.", "properties": { "showAddresses": { "description": "If this property is set to true, then underlying geofence addresses will be shown in reports instead of a geofence's name.", "example": true, "type": "boolean" } }, "type": "object" }, "CreateAttributeRequest": { "description": "A request body to create an Attribute.", "properties": { "attributeType": { "default": "string", "description": "Denotes the data type of the attribute's values. Valid values: `string`, `number`.", "enum": [ "string", "number" ], "example": "string", "type": "string" }, "attributeValueQuantity": { "default": "multi", "description": "Defines whether or not this attribute can be used on the same entity many times (with different values). Valid values: `single`, `multi`.", "enum": [ "single", "multi" ], "example": "multi", "type": "string" }, "entities": { "description": "Entities that will be applied to this attribute", "items": { "$ref": "#/components/schemas/CreateAttributeRequest_entities" }, "type": "array" }, "entityType": { "description": "Denotes the type of entity, driver or asset.", "enum": [ "driver", "asset" ], "example": "asset", "type": "string" }, "name": { "description": "Name", "example": "License Certifications", "type": "string" }, "numberValues": { "description": "Number values that can be associated with this attribute", "items": { "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "String values that can be associated with this attribute", "items": { "type": "string" }, "type": "array" } }, "required": [ "attributeType", "attributeValueQuantity", "entityType", "name" ], "type": "object" }, "CreateAttributeRequest_entities": { "properties": { "entityId": { "description": "Entity id, based on the entity type.", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "numberValues": { "description": "Number values that can be associated with this attribute", "items": { "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "String values that can be associated with this attribute", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "CreateCarrierProposedAssignmentRequest": { "description": "New assignment for a driver.", "properties": { "activeTime": { "description": "Time after which this assignment will be active and visible to the driver on the mobile app. Not setting it makes it active now. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "driverId": { "description": "ID for the driver for the driver that this assignment is for. This can be either a unique Samsara ID or an external ID for the driver.", "example": "42", "type": "string" }, "shippingDocs": { "description": "Shipping Documents that this assignment will propose to the driver.", "example": "Delivery 123, chips and soda", "maxLength": 40, "type": "string" }, "trailerIds": { "description": "IDs of trailers to propose. This can be either a unique Samsara IDs or an external IDs for the trailers. (forbidden if trailerNames is set)", "example": [ "123456789", "maintenanceId:250020" ], "items": { "type": "string" }, "type": "array" }, "trailerNames": { "description": "Names of trailers to propose. (forbidden if trailerIds is set)", "example": [ "Trailer123", "TrailerABC" ], "items": { "type": "string" }, "type": "array" }, "vehicleId": { "description": "ID for the vehicle to propose. This can be either a unique Samsara ID or an external ID for the vehicle.", "example": "123", "type": "string" } }, "required": [ "driverId", "vehicleId" ], "type": "object" }, "CreateContactRequest": { "description": "Information for adding a notification contact for alerts.", "properties": { "email": { "description": "Email address of the contact.", "example": "jane.jones@yahoo.com", "maxLength": 255, "type": "string" }, "firstName": { "description": "First name of the contact.", "example": "Jane", "maxLength": 255, "type": "string" }, "lastName": { "description": "Last name of the contact.", "example": "Jones", "maxLength": 255, "type": "string" }, "phone": { "description": "Phone number of the contact.", "example": "111-222-3344", "maxLength": 255, "type": "string" } }, "type": "object" }, "CreateDriverRequest": { "description": "Driver that should be created.", "properties": { "attributes": { "items": { "$ref": "#/components/schemas/CreateDriverRequest_attributes" }, "type": "array" }, "carrierSettings": { "$ref": "#/components/schemas/DriverCarrierSettings" }, "currentIdCardCode": { "description": "The ID Card Code on the back of the physical card assigned to the driver. Contact Samsara if you would like to enable this feature.", "example": "941767043", "type": "string" }, "eldAdverseWeatherExemptionEnabled": { "description": "Flag indicating this driver may use Adverse Weather exemptions in ELD logs.", "type": "boolean" }, "eldBigDayExemptionEnabled": { "description": "Flag indicating this driver may use Big Day exemption in ELD logs.", "type": "boolean" }, "eldDayStartHour": { "description": "`0` indicating midnight-to-midnight ELD driving hours, `12` to indicate noon-to-noon driving hours.", "type": "integer" }, "eldExempt": { "description": "Flag indicating this driver is exempt from the Electronic Logging Mandate.", "type": "boolean" }, "eldExemptReason": { "description": "Reason that this driver is exempt from the Electronic Logging Mandate (see eldExempt).", "example": "Bad driver", "type": "string" }, "eldPcEnabled": { "description": "Flag indicating this driver may select the Personal Conveyance duty status in ELD logs.", "type": "boolean" }, "eldYmEnabled": { "description": "Flag indicating this driver may select the Yard Move duty status in ELD logs.", "type": "boolean" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "hasDrivingFeaturesHidden": { "$ref": "#/components/schemas/DriverHasDrivingFeaturesHidden" }, "hosSetting": { "$ref": "#/components/schemas/DriverHosSetting" }, "licenseNumber": { "description": "Driver's state issued license number. The combination of this number and `licenseState` must be unique.", "example": "E1234567", "type": "string" }, "licenseState": { "description": "Abbreviation of US state, Canadian province, or US territory that issued driver's license.", "example": "CA", "type": "string" }, "locale": { "description": "Locale override (uncommon). These are specified by ISO 3166-2 country codes for supported locales. Valid values: `us`, `at`, `be`, `ca`, `gb`, `fr`, `de`, `ie`, `it`, `lu`, `mx`, `nl`, `es`, `ch`, `pr`.", "enum": [ "us", "at", "be", "ca", "gb", "fr", "de", "ie", "it", "lu", "mx", "nl", "es", "ch", "pr" ], "type": "string" }, "name": { "description": "Driver's name.", "example": "Susan Jones", "maxLength": 255, "minLength": 1, "type": "string" }, "notes": { "description": "Notes about the driver.", "example": "Also goes by the nickname Furious Fred.", "maxLength": 4096, "type": "string" }, "password": { "description": "Password that the driver can use to login to the Samsara driver app.", "example": "aSecurePassword1234", "type": "string" }, "peerGroupTagId": { "description": "The peer group tag id this driver belong to, used for gamification.", "type": "string" }, "phone": { "description": "Phone number of the driver.", "example": "5558234327", "maxLength": 255, "type": "string" }, "staticAssignedVehicleId": { "description": "ID of vehicle that the driver is permanently assigned to. (uncommon).", "example": "456", "type": "string" }, "tachographCardNumber": { "description": "Driver's assigned tachograph card number (Europe specific)", "example": "1000000492436002", "type": "string" }, "tagIds": { "description": "IDs of tags the driver is associated with. If your access to the API is scoped by one or more tags, this field is required to pass in.", "items": { "example": "147", "type": "string" }, "type": "array" }, "timezone": { "description": "Home terminal timezone, in order to indicate what time zone should be used to calculate the ELD logs. Driver timezones use [IANA timezone database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`, `America/New_York`, `Europe/London`, etc.). You can find a mapping of common timezone formats to IANA timezone keys [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).", "example": "America/Los_Angeles", "type": "string" }, "usDriverRulesetOverride": { "$ref": "#/components/schemas/UsDriverRulesetOverride" }, "username": { "description": "Driver's login username into the driver app. The username may not contain spaces or the '@' symbol. The username must be unique.", "example": "SusanJones", "maxLength": 189, "minLength": 1, "type": "string" }, "vehicleGroupTagId": { "description": "Tag ID which determines which vehicles a driver will see when selecting vehicles.", "example": "342417", "type": "string" }, "waitingTimeDutyStatusEnabled": { "description": "Flag indicating this driver may select waiting time duty status in ELD logs", "type": "boolean" } }, "required": [ "name", "password", "username" ], "type": "object" }, "CreateDriverRequest_attributes": { "description": "A minified attribute.", "properties": { "id": { "description": "The samsara id of the attribute object.", "example": "123e4567-e89b-12d3-a456-426614174000", "type": "string" }, "name": { "description": "Name of attribute.", "example": "License Certifications", "type": "string" }, "numberValues": { "description": "Number values that are associated with this attribute.", "items": { "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "String values that are associated with this attribute.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "CreateDvirRequest": { "description": "DVIR creation body", "properties": { "authorId": { "description": "Samsara user ID of the mechanic creating the DVIR.", "example": "11", "type": "string" }, "licensePlate": { "description": "The license plate of this vehicle.", "example": "XHK1234", "maxLength": 12, "type": "string" }, "location": { "description": "Optional string if your jurisdiction requires a location of the DVIR.", "example": "350 Rhode Island St Ste. 400S, San Francisco, CA 94103", "type": "string" }, "mechanicNotes": { "description": "The mechanics notes on the DVIR.", "example": "Replaced headlight on passenger side.", "type": "string" }, "odometerMeters": { "description": "The odometer reading in meters.", "example": 14010293, "type": "integer" }, "resolvedDefectIds": { "description": "Array of ids for defects being resolved with this DVIR.", "items": { "type": "string" }, "type": "array" }, "safetyStatus": { "description": "Whether or not this vehicle or trailer is safe to drive.", "enum": [ "safe", "unsafe" ], "example": "safe", "type": "string" }, "trailerId": { "description": "Id of trailer being inspected. Either vehicleId or trailerId must be provided.", "example": "11", "type": "string" }, "type": { "description": "Only type 'mechanic' is currently accepted.", "enum": [ "mechanic" ], "example": "mechanic", "type": "string" }, "vehicleId": { "description": "Id of vehicle being inspected. Either vehicleId or trailerId must be provided.", "example": "10", "type": "string" } }, "required": [ "authorId", "safetyStatus", "type" ], "type": "object" }, "CreateRoutesStopRequestObjectRequestBody": { "properties": { "addressId": { "description": "ID of the address. An address [externalId](https://developers.samsara.com/docs/external-ids#using-external-ids) can also be used interchangeably here.", "example": "45934", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "name": { "description": "Name of the stop", "example": "Stop #1", "type": "string" }, "notes": { "description": "Notes for the stop", "example": "These are my notes", "maxLength": 2000, "type": "string" }, "ontimeWindowAfterArrivalMs": { "description": "Specifies the time window (in milliseconds) after a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "format": "int64", "type": "integer" }, "ontimeWindowBeforeArrivalMs": { "description": "Specifies the time window (in milliseconds) before a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "format": "int64", "type": "integer" }, "scheduledArrivalTime": { "description": "This is a required field for all stops EXCEPT the start and end, based on route start and stop settings selected.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "scheduledDepartureTime": { "description": "This is a required field for all stops EXCEPT the start and end, based on route start and stop settings selected.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "singleUseLocation": { "$ref": "#/components/schemas/RoutesSingleUseAddressObjectRequestBody" } }, "type": "object" }, "CreateTagRequest": { "properties": { "addresses": { "description": "The addresses that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "assets": { "description": "The trailers, unpowered, and powered assets that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "drivers": { "description": "The drivers that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "machines": { "description": "The machines that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "name": { "description": "Name of this tag.", "example": "California", "maxLength": 191, "minLength": 1, "type": "string" }, "parentTagId": { "description": "If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.", "example": "4815", "type": "string" }, "sensors": { "description": "The sensors that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "vehicles": { "description": "The vehicles that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "CreateUserRequest": { "description": "The user creation arguments", "properties": { "authType": { "description": "The authentication type the user uses to authenticate. To use SAML this organization must have a configured SAML integration. Valid values: `default`, `saml`.", "enum": [ "default", "saml" ], "type": "string" }, "email": { "description": "The email address of this user.", "example": "user@company.com", "type": "string" }, "expireAt": { "description": "For users with temporary access, this is the expiration datetime in RFC3339 format", "example": "2025-08-13T19:08:25Z", "type": "string" }, "name": { "description": "The first and last name of the user.", "example": "Bob Smith", "type": "string" }, "roles": { "description": "The list of roles that applies to this user. A user may have \"organizational\" roles, which apply to the user at the organizational level, and \"tag-specific\" roles, which apply to the user for a given tag.", "items": { "$ref": "#/components/schemas/CreateUserRequest_roles" }, "type": "array" } }, "required": [ "authType", "email", "name", "roles" ], "type": "object" }, "CreateUserRequest_roles": { "description": "A role that applies to a user. If the role has a `tagId`, then the role applies for that tag. If there is no `tagId`, then the role applies at the organizational level. A user may have many tag-specific roles, but may only have one organizational role. If the organizational level role has higher privileges than a tag-specific role, then the organizational role privileges will take precedence.", "properties": { "roleId": { "description": "The unique ID for the role.", "example": "8a9371af-82d1-4158-bf91-4ecc8d3a114c", "type": "string" }, "tagId": { "description": "ID of the tag this role applies to.", "example": "3914", "type": "string" } }, "required": [ "roleId" ], "type": "object" }, "CruiseControlDurationMs": { "description": "Time spent in cruise control in milliseconds.", "type": "number" }, "CumulativeOperatingHoursResponseBody": { "description": "Equipment operating hours.", "properties": { "Hour": { "description": "Total number of equipment operating hours.", "example": 12.34, "format": "double", "type": "number" }, "datetime": { "description": "Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "CurrentDutyStatus": { "description": "The current HOS status type and time the driver started being in this status.", "properties": { "hosStatusType": { "description": "The Hours of Service status type. If the driver app is disconnected, an empty string will be returned. To reconnect the app and return updated values, drivers should have the app open with good cell service. Valid values: `offDuty`, `sleeperBed`, `driving`, `onDuty`, `yardMove`, `personalConveyance`.", "enum": [ "offDuty", "sleeperBed", "driving", "onDuty", "yardMove", "personalConveyance" ], "example": "offDuty", "type": "string" } }, "type": "object" }, "CustomHeadersObjectRequestBody": { "description": "This is the object that stores the key and the value of the custom headers.", "properties": { "key": { "description": "The alphanumeric key of the custom header.", "example": "format", "maxLength": 100, "type": "string" }, "value": { "description": "The value of the custom header. The default maximum length of the value is 100 characters.", "example": "xcmol-532", "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "CustomHeadersObjectResponseBody": { "description": "This is the object that stores the key and the value of the custom headers.", "properties": { "key": { "description": "The alphanumeric key of the custom header.", "example": "format", "maxLength": 100, "type": "string" }, "value": { "description": "The value of the custom header. The default maximum length of the value is 100 characters.", "example": "xcmol-532", "type": "string" } }, "required": [ "key", "value" ], "type": "object" }, "CustomMetadata": { "additionalProperties": { "type": "string" }, "description": "The custom fields of an asset.", "example": { "manufacturer": "Samsara", "serialNumber": "123ABC" }, "type": "object" }, "CustomReportColumnsObjectResponseBody": { "description": "Information about a custom report column.", "properties": { "baseUnit": { "description": "[deprecated] Use unit instead. Valid values: `bar`, `celsius`, `fahrenheit`, `foot`, `gallon`, `galpermi`, `gforce`, `gperliter`, `gperm`, `impgallon`, `impgalpermi`, `inch`, `kelvin`, `kgpergallon`, `kgperkm`, `kgperliter`, `kgpermi`, `kilogram`, `kilometer`, `kilopascal`, `kilowatthour`, `kmperhr`, `lbpermi`, `liter`, `lper100km`, `lperkm`, `lperm`, `meter`, `meterspersec`, `mile`, `milliknot`, `milliseconds`, `millivolt`, `mipergal`, `miperhr`, `miperimpgal`, `pound`, `poundsPerSquareInch`, `poundspergallon`, `poundsperliter`, `volt`, `watthour`", "enum": [ "bar", "celsius", "fahrenheit", "foot", "gallon", "galpermi", "gforce", "gperliter", "gperm", "impgallon", "impgalpermi", "inch", "kelvin", "kgpergallon", "kgperkm", "kgperliter", "kgpermi", "kilogram", "kilometer", "kilopascal", "kilowatthour", "kmperhr", "lbpermi", "liter", "lper100km", "lperkm", "lperm", "meter", "meterspersec", "mile", "milliknot", "milliseconds", "millivolt", "mipergal", "miperhr", "miperimpgal", "pound", "poundsPerSquareInch", "poundspergallon", "poundsperliter", "volt", "watthour" ], "example": "meter", "type": "string" }, "displayName": { "description": "The display name of the column that appears in the dashboard or exported csv, xlsx, and pdf reports. This value can contain whitespaces and special characters. It is not used to key the values below in the `data` array.", "example": "Attribute: Driver skill", "type": "string" }, "type": { "description": "The type of data for this column. Valid values: `string`, `numeric`", "enum": [ "string", "numeric" ], "example": "string", "type": "string" }, "unit": { "description": "The unit of the data for this column. If the data is a string or custom score (ie, anticipation score), unit will not be returned. Valid values: `bar`, `degreesCelsius`, `degreesFahrenheit`, `feet`, `gForces`, `gallons`, `gallonsPerMile`, `gramsPerLiter`, `gramsPerMeter`, `imperialGallons`, `imperialGallonsPerMile`, `inches`, `kelvin`, `kilograms`, `kilogramsPerGallon`, `kilogramsPerKilometer`, `kilogramsPerLiter`, `kilogramsPerMile`, `kilometers`, `kilometersPerHour`, `kilopascals`, `kilowattHours`, `liters`, `litersPer100Kilometers`, `litersPerKilometer`, `litersPerMeter`, `meters`, `metersPerSecond`, `miles`, `milesPerGallon`, `milesPerHour`, `milesPerImperialGallon`, `milliknots`, `milliseconds`, `millivolts`, `pounds`, `poundsPerGallon`, `poundsPerLiter`, `poundsPerMile`, `poundsPerSquareInch`, `volts`, `wattHours`", "enum": [ "bar", "degreesCelsius", "degreesFahrenheit", "feet", "gForces", "gallons", "gallonsPerMile", "gramsPerLiter", "gramsPerMeter", "imperialGallons", "imperialGallonsPerMile", "inches", "kelvin", "kilograms", "kilogramsPerGallon", "kilogramsPerKilometer", "kilogramsPerLiter", "kilogramsPerMile", "kilometers", "kilometersPerHour", "kilopascals", "kilowattHours", "liters", "litersPer100Kilometers", "litersPerKilometer", "litersPerMeter", "meters", "metersPerSecond", "miles", "milesPerGallon", "milesPerHour", "milesPerImperialGallon", "milliknots", "milliseconds", "millivolts", "pounds", "poundsPerGallon", "poundsPerLiter", "poundsPerMile", "poundsPerSquareInch", "volts", "wattHours" ], "example": "meter", "type": "string" } }, "required": [ "displayName", "type" ], "type": "object" }, "CustomReportConfigObjectResponseBody": { "description": "Full Custom report config object", "properties": { "columns": { "description": "List of custom report column objects", "items": { "$ref": "#/components/schemas/CustomReportColumnsObjectResponseBody" }, "type": "array" }, "id": { "description": "ID of the custom report config.", "example": "4f71fd67-54f0-41de-991c-ee1e031134d1", "type": "string" }, "reportName": { "description": "Name of the custom report config.", "example": "Fuel Custom Report", "type": "string" } }, "required": [ "columns", "id", "reportName" ], "type": "object" }, "CustomReportsGetCustomReportConfigsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportConfigsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportConfigsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportConfigsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportConfigsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportConfigsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportConfigsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportConfigsResponseBody": { "properties": { "data": { "description": "List of custom report config objects.", "items": { "$ref": "#/components/schemas/CustomReportConfigObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "CustomReportsGetCustomReportConfigsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportConfigsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportConfigsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/GetCustomReportRunDataObjectResponseBody" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "CustomReportsGetCustomReportRunDataServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunDataUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsResponseBody": { "properties": { "data": { "description": "List of custom report runs.", "items": { "$ref": "#/components/schemas/GetCustomReportRunObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "CustomReportsGetCustomReportRunsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsGetCustomReportRunsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunRequestBody": { "description": "This creates and queues a new custom report run for the given body parameters.", "properties": { "attributeValueIds": { "description": "The optional array of attribute value ids to filter the custom report run by.", "example": [ "19abdecf-54f0-41de-991c-ee1e031134d1", "ab83dfce-54f0-41de-991c-ee1e031134d2" ], "items": { "description": "Attribute value ids.", "example": "Ea officia libero.", "type": "string" }, "type": "array" }, "customReportId": { "description": "Required unique ID for the custom report linked to this run.", "example": "4f71fd67-54f0-41de-991c-ee1e031134d1", "type": "string" }, "endTime": { "description": "The end time of the custom report run in RFC 3339 format.", "example": "2019-06-13T21:08:25Z", "format": "date-time", "type": "string" }, "startTime": { "description": "The start time of the custom report run in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "tagIds": { "description": "The optional array of tag ids to filter the custom report run by.", "example": [48923049, 198349], "items": { "description": "Tag ids.", "example": 7.105146377725875e+18, "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "customReportId", "endTime", "startTime" ], "type": "object" }, "CustomReportsPostCustomReportRunResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PostCustomReportRunResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "CustomReportsPostCustomReportRunServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "CustomReportsPostCustomReportRunUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DEFRemainingResponseBody": { "description": "DEF remaining in equipment.", "properties": { "Percent": { "description": "Percent of DEF remaining in tank.", "example": 12, "format": "double", "type": "number" }, "datetime": { "description": "Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "DVIRSubmittedDeviceTriggerDetailsObjectRequestBody": { "description": "Details specific to DVIR Submitted by Device", "properties": { "dvirMinDurationMilliseconds": { "description": "The trigger will only fire if the selected DVIR types are submitted within the duration.", "example": 600000, "format": "int64", "type": "integer" }, "dvirSubmissionTypes": { "description": "Filter to these types of DVIR submissions.", "example": [ "SAFE_WITH_DEFECTS", "SAFE_WITH_DEFECTS" ], "items": { "description": "DVIR submission type Valid values: `SAFE_NO_DEFECTS`, `SAFE_WITH_DEFECTS`, `UNSAFE`", "enum": [ "SAFE_NO_DEFECTS", "SAFE_WITH_DEFECTS", "UNSAFE" ], "example": "SAFE_WITH_DEFECTS", "type": "string" }, "type": "array" } }, "type": "object" }, "DVIRSubmittedDeviceTriggerDetailsObjectResponseBody": { "description": "Details specific to DVIR Submitted by Device", "properties": { "dvirMinDurationMilliseconds": { "description": "The trigger will only fire if the selected DVIR types are submitted within the duration.", "example": 600000, "format": "int64", "type": "integer" }, "dvirSubmissionTypes": { "description": "Filter to these types of DVIR submissions.", "example": [ "SAFE_NO_DEFECTS", "SAFE_NO_DEFECTS", "UNSAFE", "UNSAFE" ], "items": { "description": "DVIR submission type Valid values: `SAFE_NO_DEFECTS`, `SAFE_WITH_DEFECTS`, `UNSAFE`", "enum": [ "SAFE_NO_DEFECTS", "SAFE_WITH_DEFECTS", "UNSAFE" ], "example": "UNSAFE", "type": "string" }, "type": "array" } }, "type": "object" }, "DashcamDisconnectedResponseBody": { "description": "Details specific to Dashcam Disconnected.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "DataInputListResponse": { "properties": { "data": { "description": "An array of data input data points. Each object in the array represents a data input and will contain its associated data points.", "items": { "$ref": "#/components/schemas/DataInputResponse" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "DataInputResponse": { "allOf": [ { "$ref": "#/components/schemas/DataInputTinyResponse" }, { "$ref": "#/components/schemas/DataInputResponse_allOf" } ] }, "DataInputResponse_allOf": { "properties": { "fftSpectraPoints": { "description": "List of FFT spectra data points from the data input.", "items": { "$ref": "#/components/schemas/FftSpectraDataPoint" }, "type": "array" }, "j1939D1StatusPoints": { "description": "List of active J1939D1 statuses.", "items": { "$ref": "#/components/schemas/J1939D1StatusDataPoint" }, "type": "array" }, "locationPoints": { "description": "List of location data points from the data input.", "items": { "$ref": "#/components/schemas/LocationDataPoint" }, "type": "array" }, "numberPoints": { "description": "List of numeric data points from the data input.", "items": { "$ref": "#/components/schemas/NumberDataPoint" }, "type": "array" }, "stringPoints": { "description": "List of string data points from the data input.", "items": { "$ref": "#/components/schemas/StringDataPoint" }, "type": "array" } }, "type": "object" }, "DataInputSnapshot": { "allOf": [ { "$ref": "#/components/schemas/DataInputTinyResponse" }, { "$ref": "#/components/schemas/DataInputSnapshot_allOf" } ] }, "DataInputSnapshotResponse": { "properties": { "data": { "description": "An array of data inputs' latest data points. Each object in the array represents a data input and its most recent data point.", "items": { "$ref": "#/components/schemas/DataInputSnapshot" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "DataInputSnapshot_allOf": { "properties": { "fftSpectraPoint": { "$ref": "#/components/schemas/FftSpectraDataPoint" }, "j1939D1StatusPoint": { "$ref": "#/components/schemas/J1939D1StatusDataPoint" }, "locationPoint": { "$ref": "#/components/schemas/LocationDataPoint" }, "numberPoint": { "$ref": "#/components/schemas/NumberDataPoint" }, "stringPoint": { "$ref": "#/components/schemas/StringDataPoint" } }, "type": "object" }, "DataInputTinyResponse": { "description": "A minified data input object", "properties": { "assetId": { "description": "Unique identifier for the data input's asset.", "example": "74771078-5edb-4733-88f2-7242f520d1f1", "format": "uuid", "type": "string" }, "dataGroup": { "description": "Data group for this data input.", "example": "Flow", "format": "string", "type": "string" }, "id": { "description": "Unique identifier for the data input.", "format": "uuid", "type": "string" }, "name": { "description": "Name of this data input.", "example": "Pump Flow", "format": "string", "type": "string" }, "units": { "description": "Units of data for this data input.", "example": "Gallons Per Minute", "format": "string", "type": "string" } }, "type": "object" }, "DataInputValueResponseBody": { "description": "Details specific to Data Input Value.", "properties": { "machineInput": { "$ref": "#/components/schemas/alertObjectMachineInputResponseBody" } }, "type": "object" }, "DataInputsTinyResponse": { "properties": { "data": { "description": "An array of data input objects. Each object contains the data input's name, ID, and other metadata.", "items": { "$ref": "#/components/schemas/DataInputTinyResponse" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "DataUsageResponseObjectResponseBody": { "description": "An object containing information about the gateway data usage in mb for the last 30 days.", "properties": { "cellularDataUsageBytes": { "description": "Celluar data usage in bytes.", "example": 7.313863297400369e+18, "format": "int64", "type": "integer" }, "hotspotUsageBytes": { "description": "Wifi hotspot data usage in bytes.", "example": 4.2745263894045445e+18, "format": "int64", "type": "integer" } }, "type": "object" }, "DefLevelTriggerDetailsObjectRequestBody": { "description": "Details specific to DEF Level", "properties": { "defLevelPercent": { "description": "The DEF percentage threshold value.", "example": 100, "format": "int64", "type": "integer" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `GREATER`, `LESS`", "enum": [ "GREATER", "LESS" ], "example": "GREATER", "type": "string" } }, "required": [ "defLevelPercent", "minDurationMilliseconds", "operation" ], "type": "object" }, "DefLevelTriggerDetailsObjectResponseBody": { "description": "Details specific to DEF Level", "properties": { "defLevelPercent": { "description": "The DEF percentage threshold value.", "example": 100, "format": "int64", "type": "integer" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `GREATER`, `LESS`", "enum": [ "GREATER", "LESS" ], "example": "GREATER", "type": "string" } }, "required": [ "defLevelPercent", "minDurationMilliseconds", "operation" ], "type": "object" }, "Defect": { "properties": { "comment": { "description": "Comment on the defect.", "example": "Air Compressor not working", "type": "string" }, "createdAtTime": { "description": "Time when the defect was created. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "defectType": { "description": "The type of DVIR defect.", "example": "Air Compressor", "type": "string" }, "id": { "description": "ID of the defect.", "example": "18", "type": "string" }, "isResolved": { "description": "Signifies if this defect is resolved.", "example": true, "type": "boolean" }, "mechanicNotes": { "description": "The mechanics notes on the defect.", "example": "Extremely large oddly shaped hole in passenger side window.", "type": "string" }, "mechanicNotesUpdatedAtTime": { "description": "Time when mechanic notes were last updated. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "resolvedAtTime": { "description": "Time when this defect was resolved. Will not be returned if the defect is unresolved. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "resolvedBy": { "$ref": "#/components/schemas/Defect_resolvedBy" }, "trailer": { "allOf": [ { "description": "The trailer this defect was submitted for.", "type": "object" }, { "$ref": "#/components/schemas/trailerTinyResponse" } ], "type": "object" }, "vehicle": { "allOf": [ { "description": "The vehicle this defect was submitted for.", "type": "object" }, { "$ref": "#/components/schemas/vehicleTinyResponse" } ], "type": "object" } }, "required": [ "id", "isResolved" ], "type": "object" }, "DefectPatch": { "description": "Information about resolving a defect. If resolving a defect, must specify `isResolved` as `true` and `resolvedBy`.", "properties": { "isResolved": { "description": "Resolves the defect. Must be `true`.", "type": "boolean" }, "mechanicNotes": { "description": "The mechanics notes on the defect.", "example": "Extremely large oddly shaped hole in passenger side window.", "type": "string" }, "resolvedAtTime": { "description": "Time when defect was resolved. Defaults to now if not provided. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "resolvedBy": { "$ref": "#/components/schemas/ResolvedBy" } }, "type": "object" }, "DefectPhotoResponseResponseBody": { "description": "Defect's photo object", "properties": { "createdAtTime": { "description": "Time when defect's photo was created in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "url": { "description": "The URL to the defect's photo. Note: the link is available only for 24 hours after it's sent", "example": "https://s3.samsara.com/samsara-driver-media-upload/defect-photo-path", "type": "string" } }, "required": [ "createdAtTime", "url" ], "type": "object" }, "DefectResponse": { "description": "A single defect.", "properties": { "data": { "$ref": "#/components/schemas/Defect" } }, "type": "object" }, "DefectTrailerResponseResponseBody": { "description": "Defect's trailer object", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the trailer", "example": "494123", "type": "string" } }, "type": "object" }, "DefectTypesResponseDataResponseBody": { "description": "Defect type data.", "properties": { "createdAtTime": { "description": "Time when defect type was created in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "id": { "description": "The unique ID of the DVIR defect type.", "example": "25d6151e-29b5-453e-875a-7c5425332e09", "type": "string" }, "label": { "description": "DVIR defect type label.", "example": "Air Compressor", "type": "string" }, "sectionType": { "description": "Section for DVIR defect type. Valid values: `exteriorFront`, `exteriorRear`, `exteriorSideUnderneath`, `interiorDriverCab`, `interiorPassengerArea`, `other`, `unknown`", "enum": [ "exteriorFront", "exteriorRear", "exteriorSideUnderneath", "interiorDriverCab", "interiorPassengerArea", "other", "unknown" ], "example": "exteriorFront", "type": "string" } }, "required": [ "createdAtTime", "id", "label", "sectionType" ], "type": "object" }, "DefectVehicleResponseResponseBody": { "description": "Defect's vehicle object", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the vehicle", "example": "494125", "type": "string" } }, "type": "object" }, "Defect_resolvedBy": { "description": "The person who resolved this defect. Will not be returned if the defect is unresolved.", "properties": { "id": { "description": "ID of the entity that resolved this defect. If the defect was resolved by a driver, this will be a Samsara Driver ID. If the defect was resolved by a mechanic, this will be the Samsara Dashboard User ID of the mechanic.", "example": "11", "type": "string" }, "name": { "description": "Name of the person who resolved this defect.", "example": "Christopher 'The Handyman' Zhen", "type": "string" }, "type": { "description": "Indicates whether this defect was resolved by a `driver` or a `mechanic`.", "enum": [ "driver", "mechanic" ], "type": "string" } }, "type": "object" }, "DefectsResponse": { "description": "A list of defects.", "properties": { "data": { "items": { "$ref": "#/components/schemas/Defect" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "DefectsResponseDataResponseBody": { "description": "DVIR defects data.", "properties": { "comment": { "description": "Comment on the defect.", "example": "Engine failure.", "type": "string" }, "createdAtTime": { "description": "Time when defect was created in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "defectPhotos": { "description": "List of DVIR defect's photos", "items": { "$ref": "#/components/schemas/DefectPhotoResponseResponseBody" }, "type": "array" }, "defectTypeId": { "description": "The unique ID of the defect type.", "example": "25d6151e-29b5-453e-875a-7c5425332e09", "type": "string" }, "dvirId": { "description": "The unique ID of the defect's DVIR.", "example": "292371177", "type": "string" }, "id": { "description": "The unique ID of the DVIR defect.", "example": "9700544", "type": "string" }, "isResolved": { "description": "Signifies if this defect is resolved.", "example": true, "type": "boolean" }, "mechanicNotes": { "description": "The mechanics notes on the defect.", "example": "Broken passenger side window.", "type": "string" }, "resolvedAtTime": { "description": "Time when this defect was resolved in RFC 3339 format. Will not be returned if the defect is unresolved.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "resolvedBy": { "$ref": "#/components/schemas/DvirResolvedByObjectResponseBody" }, "trailer": { "$ref": "#/components/schemas/DefectTrailerResponseResponseBody" }, "updatedAtTime": { "description": "Time when defect was last updated in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/DefectVehicleResponseResponseBody" } }, "required": [ "comment", "dvirId", "id", "isResolved" ], "type": "object" }, "DeviceAssetResponseResponseBody": { "description": "Asset that the device is tied to.", "properties": { "id": { "description": "The unique ID of the asset.", "example": "281474982859091", "type": "string" }, "name": { "description": "The human-readable name of the asset. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "MyAsset-1234", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "DeviceMovementDataResponseBody": { "description": "Details specific to Device Movement.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "DeviceMovementStoppedDataResponseBody": { "description": "Details specific to Device Movement Stopped.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "DeviceMovementTriggerDetailsObjectRequestBody": { "description": "Details specific to Device Movement", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "DeviceMovementTriggerDetailsObjectResponseBody": { "description": "Details specific to Device Movement", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "DeviceResponseResponseBody": { "description": "Information about a device including its identity, last known location, last connected time, and health status.", "properties": { "asset": { "$ref": "#/components/schemas/DeviceAssetResponseResponseBody" }, "health": { "$ref": "#/components/schemas/HealthResponseResponseBody" }, "lastConnectedTime": { "description": "The last time the device was connected, in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "lastKnownLocation": { "$ref": "#/components/schemas/LastKnownLocationResponseResponseBody" }, "model": { "description": "The product model name of the device. Valid values: `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`, `CM31`, `CM32`, `CM33`, `CM34`, `VG34`, `VG34EU`, `VG34FN`, `VG34M`, `VG54EU`, `VG54NA`, `VG55EU`, `VG55NA`", "enum": [ "AG24", "AG24EU", "AG26", "AG26EU", "AG45", "AG45EU", "AG46", "AG46EU", "AG46P", "AG46PEU", "AG51", "AG51EU", "AG52", "AG52EU", "AG53", "AG53EU", "CM31", "CM32", "CM33", "CM34", "VG34", "VG34EU", "VG34FN", "VG34M", "VG54EU", "VG54NA", "VG55EU", "VG55NA" ], "example": "AG24", "type": "string" }, "serial": { "description": "The serial number of the device.", "example": "ABCD-123-EFG", "type": "string" } }, "required": [ "asset", "model", "serial" ], "type": "object" }, "DevicesGetDevicesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DevicesGetDevicesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DevicesGetDevicesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DevicesGetDevicesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DevicesGetDevicesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DevicesGetDevicesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DevicesGetDevicesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DevicesGetDevicesResponseBody": { "properties": { "data": { "description": "List of device objects.", "items": { "$ref": "#/components/schemas/DeviceResponseResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DevicesGetDevicesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DevicesGetDevicesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DevicesGetDevicesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DistanceDrivenMeters": { "description": "Distance driven in meters.", "type": "number" }, "DistanceResponseBody": { "description": "Equipment odometer distance.", "properties": { "Odometer": { "description": "Odometer value reported by equipment.", "example": 12, "format": "double", "type": "number" }, "OdometerUnits": { "description": "Unit of measurement for distance.", "example": "kilometre", "type": "string" }, "datetime": { "description": "Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "DistanceTraveledObjectResponseBody": { "description": "The distance traveled information of the log.", "properties": { "driveDistanceMeters": { "description": "Distance driven in meters, rounded to two decimal places.", "example": 796625, "format": "int64", "type": "integer" }, "personalConveyanceDistanceMeters": { "description": "Distance driven for personal conveyance, rounded to two decimal places.", "example": 27358, "format": "int64", "type": "integer" }, "yardMoveDistanceMeters": { "description": "Distance driven for yard moves, rounded to two decimal places.", "example": 1287, "format": "int64", "type": "integer" } }, "type": "object" }, "DistractedDrivingDetectionAlertSettingsObjectResponseBody": { "description": "Enables AI detection of distracted driving, surfaces events in Safety Inbox, and enables configurable alerts. By default, Distracted Driving will impact the drivers' safety score.", "properties": { "inattentiveDrivingDetectionAlerts": { "$ref": "#/components/schemas/InattentiveDrivingDetectionAlertSettingsObjectResponseBody" }, "isEnabled": { "description": "Indicates whether AI event detection for distracted driving behaviors is turned on.", "example": true, "type": "boolean" }, "mobileUsageDetectionAlerts": { "$ref": "#/components/schemas/MobileUsageDetectionAlertSettingsObjectResponseBody" } }, "type": "object" }, "DocumentPdfGenerationRequest": { "description": "Identifies a document for PDF generation.", "properties": { "documentId": { "description": "ID of the document.", "example": "6c8c0c01-206a-41a4-9d21-15b9978d04cb", "type": "string" } }, "required": [ "documentId" ], "type": "object" }, "DocumentPdfGenerationResponse": { "description": "Identifies a PDF generation job.", "properties": { "data": { "$ref": "#/components/schemas/DocumentPdfGenerationResponse_data" } }, "type": "object" }, "DocumentPdfGenerationResponse_data": { "properties": { "documentId": { "description": "ID of the document.", "example": "6c8c0c01-206a-41a4-9d21-15b9978d04cb", "type": "string" }, "id": { "description": "ID of the PDF file generated or being generated for the document.", "example": "5c8c0c01-206a-41a4-9d21-15b9978d04cb", "type": "string" } }, "type": "object" }, "DocumentPdfQueryResponse": { "description": "A PDF of a document", "properties": { "data": { "$ref": "#/components/schemas/DocumentPdfQueryResponse_data" } }, "type": "object" }, "DocumentPdfQueryResponse_data": { "properties": { "completedAtTime": { "description": "Time that PDF generation was completed, in RFC 3339 format.", "example": "2020-01-02T15:04:06+07:00", "type": "string" }, "documentId": { "description": "ID of the document.", "example": "6c8c0c01-206a-41a4-9d21-15b9978d04cb", "type": "string" }, "downloadDocumentPdfUrl": { "description": "S3 pre-signed URL to download PDF file.", "example": "https://samsara-driver-document-pdfs.s3.us-west-2.amazonaws.com/org/38487/42a4cffc-409d-4ddf-ba1c-5e3bbb961cba?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASI...&X-Amz-Date=20200423T162507Z&X-Amz-Expires=86400&X-Amz-Security-Token=IQoJ...-Amz-SignedHeaders=host&response-expires=2020-04-24T16%3A25%3A07Z&X-Amz-Signature=1c6fe87...", "type": "string" }, "id": { "description": "ID of the PDF file generated or being generated for the document", "example": "5c8c0c01-206a-41a4-9d21-15b9978d04cb", "type": "string" }, "jobStatus": { "description": "Describes status of the PDF generation job. Valid values: `requested`, `processing`, `completed`. ", "enum": [ "requested", "processing", "completed" ], "example": "Completed", "type": "string" }, "requestedAtTime": { "description": "Time that PDF generation was requested, in RFC 3339 format.", "example": "2020-01-02T15:04:05+07:00", "type": "string" } }, "type": "object" }, "DocumentTypesGetDocumentTypesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentTypesGetDocumentTypesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentTypesGetDocumentTypesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentTypesGetDocumentTypesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentTypesGetDocumentTypesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentTypesGetDocumentTypesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentTypesGetDocumentTypesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentTypesGetDocumentTypesResponseBody": { "properties": { "data": { "description": "List of all document types for the organization", "example": [ { "conditionalFieldSections": [ { "conditionalFieldFirstIndex": 1, "conditionalFieldLastIndex": 2, "triggeringFieldIndex": 0, "triggeringFieldValue": "Yes" } ], "fieldTypes": [ { "fieldType": "multipleChoice", "label": "Was there damage?", "multipleChoiceFieldTypeMetaData": [ { "label": "Yes" }, { "label": "No" } ], "requiredField": true }, { "fieldType": "photo", "label": "Damage Photos", "requiredField": false }, { "fieldType": "number", "label": "Number of vehicles impacted", "numberFieldTypeMetaData": { "numberOfDecimalPlaces": 2 }, "requiredField": false }, { "fieldType": "dateTime", "label": "Date and time", "requiredField": true }, { "fieldType": "signature", "label": "Sign", "requiredField": true, "signatureFieldTypeMetaData": { "legalText": "Legal Text" } } ], "id": "4aff772c-a7bb-45e6-8e41-6a53e34feb83", "name": "Accident Report", "orgId": 12345 } ], "items": { "$ref": "#/components/schemas/getDocumentTypeResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DocumentTypesGetDocumentTypesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentTypesGetDocumentTypesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentTypesGetDocumentTypesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsDeleteDocumentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/documentResponseObjectResponseBody" } }, "type": "object" }, "DocumentsGetDocumentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsResponseBody": { "properties": { "data": { "description": "Multiple documents.", "items": { "$ref": "#/components/schemas/documentResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DocumentsGetDocumentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsGetDocumentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentRequestBody": { "properties": { "documentTypeId": { "description": "ID for the document type.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "driverId": { "description": "ID of the driver. Can be either unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the driver.", "example": "45646", "type": "string" }, "fields": { "description": "The fields associated with this document.", "items": { "$ref": "#/components/schemas/fieldObjectPostRequestBody" }, "type": "array" }, "name": { "description": "Name of the document.", "example": "Dropoff Slip 123", "type": "string" }, "notes": { "description": "Notes on the document.", "example": "Missing a crate", "maxLength": 2000, "type": "string" }, "routeStopId": { "description": "ID of the route stop. Can be either unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the route stop.", "example": "45646", "type": "string" }, "state": { "default": "required", "description": "The condition of the document created for the driver. Can be either `required` or `submitted`, if no value is specified, `state` defaults to `required`. `required` documents are pre-populated documents for the Driver to fill out in the Driver App. Valid values: `submitted`, `required`", "enum": [ "submitted", "required" ], "example": "submitted", "type": "string" }, "vehicleId": { "description": "ID of the vehicle. Can be either unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the vehicle.", "example": "45646", "type": "string" } }, "required": [ "documentTypeId", "driverId" ], "type": "object" }, "DocumentsPostDocumentResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/documentResponseObjectResponseBody" } }, "type": "object" }, "DocumentsPostDocumentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DocumentsPostDocumentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriveTimeDurationMs": { "description": "Time driven in milliseconds.", "type": "number" }, "Driver": { "description": "A driver object", "properties": { "attributes": { "description": "A minified attribute", "items": { "$ref": "#/components/schemas/attributeTiny" }, "type": "array" }, "carrierSettings": { "$ref": "#/components/schemas/DriverCarrierSettings" }, "createdAtTime": { "$ref": "#/components/schemas/DriverCreatedAtTime" }, "currentIdCardCode": { "$ref": "#/components/schemas/DriverIdCardCode" }, "driverActivationStatus": { "$ref": "#/components/schemas/DriverActivationStatus" }, "eldAdverseWeatherExemptionEnabled": { "$ref": "#/components/schemas/DriverEldAdverseWeatherExemptionEnabled" }, "eldBigDayExemptionEnabled": { "$ref": "#/components/schemas/DriverEldBigDayExemptionEnabled" }, "eldDayStartHour": { "$ref": "#/components/schemas/DriverEldDayStartHour" }, "eldExempt": { "$ref": "#/components/schemas/DriverEldExempt" }, "eldExemptReason": { "$ref": "#/components/schemas/DriverEldExemptReason" }, "eldPcEnabled": { "$ref": "#/components/schemas/DriverEldPcEnabled" }, "eldSettings": { "$ref": "#/components/schemas/DriverEldSettings" }, "eldYmEnabled": { "$ref": "#/components/schemas/DriverEldYmEnabled" }, "externalIds": { "$ref": "#/components/schemas/DriverExternalIds" }, "hasDrivingFeaturesHidden": { "$ref": "#/components/schemas/DriverHasDrivingFeaturesHidden" }, "id": { "$ref": "#/components/schemas/DriverId" }, "isDeactivated": { "$ref": "#/components/schemas/DriverIsDeactivated" }, "licenseNumber": { "$ref": "#/components/schemas/DriverLicenseNumber" }, "licenseState": { "$ref": "#/components/schemas/DriverLicenseState" }, "locale": { "$ref": "#/components/schemas/DriverLocale" }, "name": { "$ref": "#/components/schemas/DriverName" }, "notes": { "$ref": "#/components/schemas/DriverNotes" }, "peerGroupTag": { "$ref": "#/components/schemas/tagTinyResponse" }, "phone": { "$ref": "#/components/schemas/DriverPhone" }, "staticAssignedVehicle": { "$ref": "#/components/schemas/DriverStaticAssignedVehicle" }, "tachographCardNumber": { "$ref": "#/components/schemas/DriverTachographCardNumber" }, "tags": { "$ref": "#/components/schemas/DriverTags" }, "timezone": { "$ref": "#/components/schemas/DriverTimezone" }, "updatedAtTime": { "$ref": "#/components/schemas/DriverUpdatedAtTime" }, "usDriverRulesetOverride": { "$ref": "#/components/schemas/UsDriverRulesetOverride" }, "username": { "$ref": "#/components/schemas/DriverUsername" }, "vehicleGroupTag": { "$ref": "#/components/schemas/DriverVehicleGroupTag" }, "waitingTimeDutyStatusEnabled": { "$ref": "#/components/schemas/DriverWaitingTimeDutyStatusEnabled" } }, "type": "object" }, "DriverActivationStatus": { "description": "A value indicating whether the driver is active or deactivated. Valid values: `active`, `deactivated`.", "enum": [ "active", "deactivated" ], "type": "string" }, "DriverAppNotificationObjectRequestBody": { "description": "Driver app notification settings", "properties": { "inAppNotificationOptions": { "$ref": "#/components/schemas/InAppNotificationOptionsObjectRequestBody" }, "pushNotificationOptions": { "$ref": "#/components/schemas/PushNotificationOptionsObjectRequestBody" } }, "type": "object" }, "DriverAppNotificationObjectResponseBody": { "description": "Driver app notification settings", "properties": { "inAppNotificationOptions": { "$ref": "#/components/schemas/InAppNotificationOptionsObjectResponseBody" }, "pushNotificationOptions": { "$ref": "#/components/schemas/PushNotificationOptionsObjectResponseBody" } }, "type": "object" }, "DriverAppSettingsGamificationConfigTinyObjectRequestBody": { "description": "Gamification configuration for the Driver App.", "properties": { "anonymizeDriverNames": { "description": "Hide the names of other drivers when viewing the driver leaderboard in the mobile app.", "example": false, "type": "boolean" } }, "type": "object" }, "DriverAppSettingsGamificationConfigTinyObjectResponseBody": { "description": "Gamification configuration for the Driver App.", "properties": { "anonymizeDriverNames": { "description": "Hide the names of other drivers when viewing the driver leaderboard in the mobile app.", "example": false, "type": "boolean" } }, "type": "object" }, "DriverAppSettingsResponseObjectResponseBody": { "description": "The configuration settings for the Samsara Driver App. Can be set or updated through the Samsara Settings page or the API at any time.", "properties": { "driverFleetId": { "description": "Login user name for the fleet driver app", "example": "abc_trucking_co", "type": "string" }, "gamification": { "description": "Driver gamification feature. Enabling this will turn on the feature for all drivers using the mobile app. Drivers can be configured into peer groups within the Drivers Page. Unconfigured drivers will be grouped on an organization level.", "example": true, "type": "boolean" }, "gamificationConfig": { "$ref": "#/components/schemas/DriverAppSettingsGamificationConfigTinyObjectResponseBody" }, "orgVehicleSearch": { "description": "Allow drivers to search for vehicles outside of their selection tag when connected to the internet.", "example": true, "type": "boolean" }, "trailerSelection": { "description": "Allow drivers to see and select trailers in the Samsara Driver app. ", "example": true, "type": "boolean" }, "trailerSelectionConfig": { "$ref": "#/components/schemas/DriverAppSettingsTrailerSelectionConfigTinyObjectResponseBody" } }, "type": "object" }, "DriverAppSettingsTrailerSelectionConfigTinyObjectRequestBody": { "description": "Trailer selection setting configuration for the Driver App.", "properties": { "driverTrailerCreationEnabled": { "description": "Allow drivers to create new trailers in the Samsara Driver app.", "example": false, "type": "boolean" }, "maxNumOfTrailersSelected": { "description": "Trailer selection limit.", "maximum": 8, "type": "integer" }, "orgTrailerSearch": { "description": "Allow drivers to search for trailers outside of their selection tag when connected to the internet", "example": true, "type": "boolean" } }, "type": "object" }, "DriverAppSettingsTrailerSelectionConfigTinyObjectResponseBody": { "description": "Trailer selection setting configuration for the Driver App.", "properties": { "driverTrailerCreationEnabled": { "description": "Allow drivers to create new trailers in the Samsara Driver app.", "example": false, "type": "boolean" }, "maxNumOfTrailersSelected": { "description": "Trailer selection limit.", "maximum": 8, "type": "integer" }, "orgTrailerSearch": { "description": "Allow drivers to search for trailers outside of their selection tag when connected to the internet", "example": true, "type": "boolean" } }, "type": "object" }, "DriverAppSignInResponseBody": { "description": "Details specific to Driver App Sign In.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" } }, "type": "object" }, "DriverAppSignOutResponseBody": { "description": "Details specific to Driver App Sign Out.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" } }, "type": "object" }, "DriverAssignmentMetadataTinyObjectResponseBody": { "description": "Metadata object for external assignment source data.", "properties": { "sourceName": { "description": "Assigned source name from an external source.", "example": "ExternalSourceName", "type": "string" } }, "type": "object" }, "DriverAssignmentObjectResponseBody": { "properties": { "assignmentType": { "description": "Assignment type of the driver-vehicle assignment, indicating the provenance of the assignment. The only type of assignment supported right now is `driverApp` assignments. This list could change, so it is recommended that clients gracefully handle any types not enumerated in this list. Valid values: `driverApp`", "enum": [ "driverApp" ], "example": "driverApp", "type": "string" }, "driver": { "$ref": "#/components/schemas/GoaDriverTinyResponseResponseBody" }, "endTime": { "description": " An end time in RFC 3339 format. Omitted if not applicable. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "isPassenger": { "description": "Boolean indicating whether the driver is a passenger.", "example": false, "type": "boolean" }, "startTime": { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "DriverCarrierName": { "description": "Carrier for a given driver.", "example": "Acme Inc.", "maxLength": 255, "type": "string" }, "DriverCarrierSettings": { "description": "Carrier for a given driver. If the driver's carrier differs from the general organization's carrier settings, the override value is used. Updating this value only updates the override setting for this driver.", "properties": { "carrierName": { "description": "Carrier for a given driver.", "example": "Acme Inc.", "maxLength": 255, "type": "string" }, "dotNumber": { "description": "Carrier US DOT Number. If this differs from the general organization's settings, the override value is used. Updating this value only updates the override setting for this driver.", "example": 98231, "format": "int64", "type": "integer" }, "homeTerminalAddress": { "$ref": "#/components/schemas/DriverHomeTerminalAddress" }, "homeTerminalName": { "$ref": "#/components/schemas/DriverHomeTerminalName" }, "mainOfficeAddress": { "description": "Main office address for a given driver. If this differs from the general organization's settings, the override value is used. ", "example": "1234 Pear St., Scranton, PA 62814", "maxLength": 255, "type": "string" } }, "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentResponseBody": { "properties": { "data": { "description": "List of driver coach assignment objects", "items": { "$ref": "#/components/schemas/CoachAssignmentWithDriverExternalIdsResponseResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsGetDriverCoachAssignmentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/CoachAssignmentWithoutDriverExternalIdsResponseResponseBody" } }, "required": [ "data" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCoachAssignmentsPutDriverCoachAssignmentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverCreatedAtTime": { "description": "The date and time this driver was created in RFC 3339 format.", "example": "2019-05-18T20:27:35Z", "type": "string" }, "DriverDeactivatedAtTime": { "description": "The date and time this driver is considered to be deactivated in RFC 3339 format.", "example": "2019-05-18T20:27:35Z", "type": "string" }, "DriverDocumentSubmittedDetailsObjectRequestBody": { "description": "Details specific to Driver Document Submitted", "properties": { "templateIds": { "description": "Specific template IDs to be alerted on.", "example": [ "23b78345-d098-3k4j-1pk3-4k5j6938j289", "23b78345-d098-3k4j-1pk3-4k5j6938j289" ], "items": { "description": "The unique IDs of the template.", "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "templateIds" ], "type": "object" }, "DriverDocumentSubmittedDetailsObjectResponseBody": { "description": "Details specific to Driver Document Submitted", "properties": { "templateIds": { "description": "Specific template IDs to be alerted on.", "example": [ "23b78345-d098-3k4j-1pk3-4k5j6938j289", "23b78345-d098-3k4j-1pk3-4k5j6938j289" ], "items": { "description": "The unique IDs of the template.", "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "templateIds" ], "type": "object" }, "DriverDocumentSubmittedResponseBody": { "description": "Details specific to Driver Document Submitted.", "properties": { "document": { "$ref": "#/components/schemas/documentResponseObjectResponseBody" } }, "type": "object" }, "DriverDotNumber": { "description": "Carrier US DOT Number. If this differs from the general organization's settings, the override value is used. Updating this value only updates the override setting for this driver.", "example": 98231, "format": "int64", "type": "integer" }, "DriverEfficienciesResponse": { "description": "Summary of drivers' efficiencies over a time range.", "properties": { "data": { "$ref": "#/components/schemas/DriverEfficienciesResponse_data" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "DriverEfficienciesResponse_data": { "properties": { "driverSummaries": { "description": "A list of driver and associated vehicle efficiency data.", "items": { "$ref": "#/components/schemas/DriverEfficiency" }, "type": "array" }, "summaryEndTime": { "description": "End time of the window for which this efficiency report was computed. Will be a UTC timestamp in RFC 3339 format. For example: `2020-03-16T16:00:00Z`", "example": "2020-03-16T16:00:00Z", "format": "date-time", "type": "string" }, "summaryStartTime": { "description": "Start time of the window for which this efficiency report was computed. Will be a UTC timestamp in RFC 3339 format. For example: `2020-03-15T16:00:00Z`", "example": "2020-03-15T16:00:00Z", "format": "date-time", "type": "string" } }, "type": "object" }, "DriverEfficiency": { "description": "Summary of a driver's efficiency.", "properties": { "anticipationBrakeEventCount": { "$ref": "#/components/schemas/AnticipationBrakeEventCount" }, "coastingDurationMs": { "$ref": "#/components/schemas/CoastingDurationMs" }, "cruiseControlDurationMs": { "$ref": "#/components/schemas/CruiseControlDurationMs" }, "driver": { "$ref": "#/components/schemas/ExtendedDriverTinyResponse" }, "greenBandDrivingDurationMs": { "$ref": "#/components/schemas/GreenBandDrivingDurationMs" }, "highTorqueMs": { "$ref": "#/components/schemas/HighTorqueMs" }, "overSpeedMs": { "$ref": "#/components/schemas/OverSpeedMs" }, "totalBrakeEventCount": { "$ref": "#/components/schemas/TotalBrakeEventCount" }, "totalDistanceDrivenMeters": { "$ref": "#/components/schemas/DistanceDrivenMeters" }, "totalDriveTimeDurationMs": { "$ref": "#/components/schemas/DriveTimeDurationMs" }, "totalFuelConsumedMl": { "$ref": "#/components/schemas/FuelConsumedMl" }, "totalIdleTimeDurationMs": { "$ref": "#/components/schemas/IdleTimeDurationMs" }, "totalPowerTakeOffDurationMs": { "$ref": "#/components/schemas/PowerTakeOffDurationMs" }, "vehicleSummaries": { "description": "Summaries of vehicle efficiency for each vehicle the driver was driving during the given time period.", "items": { "$ref": "#/components/schemas/VehicleSummary" }, "type": "array" } }, "type": "object" }, "DriverEfficiencyDataObjectResponseBody": { "description": "Driver Efficiency score data. This object is returned by default or when the “score” format is specified in “dataFormats”.", "properties": { "anticipationScore": { "description": "Represents the anticipation score for the driver. The score will be in either number or letter format depending on the organisation config.", "example": "C", "type": "string" }, "coastingScore": { "description": "Represents the coasting score for the driver. The score will be in either number or letter format depending on the organisation config.", "example": "C", "type": "string" }, "cruiseControlScore": { "description": "Represents the cruise control score for the driver. The score will be in either number or letter format depending on the organisation config.", "example": "B", "type": "string" }, "greenBandScore": { "description": "Represents the green band score for the driver. The score will be in either number or letter format depending on the organisation config.", "example": "A", "type": "string" }, "highTorqueScore": { "description": "Represents the high torque score for the driver. The score will be in either number or letter format depending on the organisation config.", "example": "A", "type": "string" }, "idlingScore": { "description": "Represents the idling score for the driver.The score will be in either number or letter format depending on the organisation config.", "example": "B", "type": "string" }, "overSpeedScore": { "description": "Represents the over speed score for the driver. The score will be in either number or letter format depending on the organisation config.", "example": "B", "type": "string" }, "overallScore": { "description": "Represents the overall score for the driver. The score will be in either number (0-100) as a string or letter format (A-G) depending on the organisation config.", "example": "A", "type": "string" }, "wearFreeBrakeScore": { "description": "Represents the ware-free breaking score for the driver. The score will be in either number or letter format depending on the organisation config.", "example": "A", "type": "string" } }, "required": [ "overallScore" ], "type": "object" }, "DriverEfficiencyDifficultyScoreDataObjectResponseBody": { "description": "Difficulty score won't be available if there is no data to compute it against.", "properties": { "overallScore": { "description": "Represents the overall difficulty score. It has scores from 1 to 5.", "example": "4", "type": "string" }, "topographyScore": { "description": "Represents the topography difficulty score. It has scores from 1 to 5.", "example": "5", "type": "string" }, "vehicleWeightScore": { "description": " Represents the average vehicle weight score. It has scores from 1 to 5.", "example": "4", "type": "string" } }, "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversResponseBody": { "properties": { "data": { "description": "List of driver efficiency data associated with drivers.", "items": { "$ref": "#/components/schemas/singleDriverEfficiencyByDriverDataObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByDriversUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesResponseBody": { "properties": { "data": { "description": "List of driver efficiency data associated with vehicles.", "items": { "$ref": "#/components/schemas/singleDriverEfficiencyByVehicleDataObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyGetDriverEfficiencyByVehiclesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverEfficiencyPercentageDataObjectResponseBody": { "description": "Driver Efficiency percentage data. This object is returned when the “percentage” format is specified in “dataFormats”.", "properties": { "anticipationPercentage": { "description": "Percentage of time a driver is in quickly breaking events vs total breaking events.", "example": 9.5, "format": "double", "type": "number" }, "coastingPercentage": { "description": "Percentage of time a driver is in coasting.", "example": 45.6, "format": "double", "type": "number" }, "cruiseControlPercentage": { "description": "Percentage of time a vehicle is in cruise control.", "example": 45.6, "format": "double", "type": "number" }, "greenBandPercentage": { "description": "Percentage of time a driver is driving within the green band.", "example": 78.9, "format": "double", "type": "number" }, "highGradeRoadDrivingPercentage": { "description": "Percentage of time a driver is driving on high-grade road.", "example": 15.3, "format": "double", "type": "number" }, "highTorquePercentage": { "description": "Percentage of time a driver is driving in high torque.", "example": 23.4, "format": "double", "type": "number" }, "idlingPercentage": { "description": "Percentage of time a driver is idling.", "example": 12.8, "format": "double", "type": "number" }, "overSpeedPercentage": { "description": "Percentage of time a driver is in over-speeding.", "example": 5.6, "format": "double", "type": "number" }, "wearFreeBrakePercentage": { "description": "Percentage of time a driver is in wear-free breaking.", "example": 88.2, "format": "double", "type": "number" } }, "required": [ "idlingPercentage" ], "type": "object" }, "DriverEfficiencyRawDataObjectResponseBody": { "description": "Driver Efficiency raw data. This object is returned when the “raw” format is specified in “dataFormats”.", "properties": { "anticipationBrakeEventCount": { "description": "Total number of quick braking events (less than one second after accelerating).", "example": 17, "format": "int64", "type": "integer" }, "averageVehicleWeightKg": { "description": "Average vehicle weight in kilograms.", "example": 14500, "format": "int64", "type": "integer" }, "coastingDurationMs": { "description": "Time spent without engaging the accelerator or brake in milliseconds.", "example": 1900800, "format": "int64", "type": "integer" }, "cruiseControlDurationMs": { "description": "Time spent in cruise control in milliseconds.", "example": 3283200, "format": "int64", "type": "integer" }, "driveTimeDurationMs": { "description": "Total driving time in milliseconds.", "example": 7200000, "format": "int64", "type": "integer" }, "engineOnDurationMs": { "description": "Total engine-on time in milliseconds.", "example": 7500000, "format": "int64", "type": "integer" }, "greenBandDurationMs": { "description": "Time spent driving within the configurable green band in milliseconds.", "example": 5683200, "format": "int64", "type": "integer" }, "highGradeRoadDrivingDurationMs": { "description": "Time spent driving on high-grade roads in milliseconds.", "example": 1108800, "format": "int64", "type": "integer" }, "highTorqueDurationMs": { "description": "Time the vehicle engine torque is greater than 90% in milliseconds. ", "example": 1684800, "format": "int64", "type": "integer" }, "idlingDurationMs": { "description": "Time spent idling in milliseconds.", "example": 921600, "format": "int64", "type": "integer" }, "overSpeedDurationMs": { "description": "Time spent over-speeding in milliseconds.", "example": 403200, "format": "int64", "type": "integer" }, "totalBrakeDurationMs": { "description": "Total breaking time in milliseconds.", "example": 1022400, "format": "int64", "type": "integer" }, "totalBrakeEventCount": { "description": "Total number of brake events.", "example": 85, "format": "int64", "type": "integer" }, "wearFreeBrakeDurationMs": { "description": "Time spent ware-free breaking in milliseconds.", "example": 6340800, "format": "int64", "type": "integer" } }, "required": [ "driveTimeDurationMs", "engineOnDurationMs", "idlingDurationMs", "totalBrakeDurationMs" ], "type": "object" }, "DriverEldAdverseWeatherExemptionEnabled": { "default": false, "description": "Flag indicating this driver may use Adverse Weather exemptions in ELD logs.", "type": "boolean" }, "DriverEldBigDayExemptionEnabled": { "default": false, "description": "Flag indicating this driver may use Big Day exemption in ELD logs.", "type": "boolean" }, "DriverEldDayStartHour": { "default": 0, "description": "`0` indicating midnight-to-midnight ELD driving hours, `12` to indicate noon-to-noon driving hours.", "type": "integer" }, "DriverEldExempt": { "default": false, "description": "Flag indicating this driver is exempt from the Electronic Logging Mandate.", "type": "boolean" }, "DriverEldExemptReason": { "description": "Reason that this driver is exempt from the Electronic Logging Mandate (see eldExempt).", "example": "Bad driver", "type": "string" }, "DriverEldPcEnabled": { "default": false, "description": "Flag indicating this driver may select the Personal Conveyance duty status in ELD logs.", "type": "boolean" }, "DriverEldRuleset": { "description": "An ELD ruleset for a driver.", "properties": { "break": { "$ref": "#/components/schemas/DriverEldRulesetRestBreak" }, "cycle": { "$ref": "#/components/schemas/DriverEldRulesetCycle" }, "jurisdiction": { "$ref": "#/components/schemas/DriverEldRulesetJurisdiction" }, "restart": { "$ref": "#/components/schemas/DriverEldRulesetRestart" }, "shift": { "$ref": "#/components/schemas/DriverEldRulesetShift" } }, "type": "object" }, "DriverEldRulesetCreatedAtTime": { "description": "The date and time this driver ELD ruleset was created in RFC 3339 format.", "example": "2019-05-18T20:27:35Z", "type": "string" }, "DriverEldRulesetCycle": { "description": "The cycle of the ELD ruleset applied to this driver. Valid values: `USA 60 hour / 7 day`, `USA 70 hour / 8 day`, `AK 80 hour / 8 day`, `AK 70 hour / 7 day`, `CA 80 hour / 8 day`, `CA 112 hour / 8 day`, `FL 80 hour / 8 day`, `FL 70 hour / 7 day`, `NE 80 hour / 8 day`, `NE 70 hour / 7 day`, `NC 80 hour / 8 day`, `NC 70 hour / 7 day`, `OK 70 hour / 8 day`, `OK 60 hour / 7 day`, `OR 80 hour / 8 day`, `OR 70 hour / 7 day`, `SC 80 hour / 8 day`, `SC 70 hour / 7 day`, `TX 70 hour / 7 day`, `WI 80 hour / 8 day`, `WI 70 hour / 7 day`, `Canada South Cycle 1 (70 hour / 7 day)`, `Canada South Cycle 2 (120 hour / 14 day)`, `Canada North Cycle 1 (80 hour / 7 day)`, `Canada North Cycle 2 (120 hour / 14 day)`.", "enum": [ "USA 60 hour / 7 day", "USA 70 hour / 8 day", "AK 80 hour / 8 day", "AK 70 hour / 7 day", "CA 80 hour / 8 day", "CA 112 hour / 8 day", "FL 80 hour / 8 day", "FL 70 hour / 7 day", "NE 80 hour / 8 day", "NE 70 hour / 7 day", "NC 80 hour / 8 day", "NC 70 hour / 7 day", "OK 70 hour / 8 day", "OK 60 hour / 7 day", "OR 80 hour / 8 day", "OR 70 hour / 7 day", "SC 80 hour / 8 day", "SC 70 hour / 7 day", "TX 70 hour / 7 day", "WI 80 hour / 8 day", "WI 70 hour / 7 day", "Canada South Cycle 1 (70 hour / 7 day)", "Canada South Cycle 2 (120 hour / 14 day)", "Canada North Cycle 1 (80 hour / 7 day)", "Canada North Cycle 2 (120 hour / 14 day)" ], "example": "USA 60 hour / 7 day", "type": "string" }, "DriverEldRulesetDailyOffDuty": { "description": "The daily off duty setting of the ELD ruleset applied to this driver.", "enum": [ "Canada South", "Canada North" ], "example": "Canada North", "type": "string" }, "DriverEldRulesetJurisdiction": { "description": "The jurisdiction of the ELD ruleset applied to this driver. These are specified by either `CS` or `CN` for Canada South and Canada North, respectively, or the ISO 3166-2 postal code for the supported state or territory.", "example": "AR", "type": "string" }, "DriverEldRulesetRestBreak": { "description": "The rest break required setting of the ELD ruleset applied to this driver. Valid values: `Property (off-duty/sleeper)`, `Explosives/HazMat (on-duty)`", "enum": [ "Property (off-duty/sleeper)", "Explosives/HazMat (on-duty)" ], "example": "Property (off-duty/sleeper)", "type": "string" }, "DriverEldRulesetRestart": { "description": "The restart of the ELD ruleset applied to this driver. Valid values: `None`, `34-hour Restart`, `24-hour Restart`, `36-hour Restart`, `72-hour Restart`.", "enum": [ "None", "34-hour Restart", "24-hour Restart", "36-hour Restart", "72-hour Restart" ], "example": "Default", "type": "string" }, "DriverEldRulesetShift": { "description": "The shift of the ELD ruleset applied to this driver. Valid values: `US Interstate Property`, `US Interstate Passenger`, `Texas Intrastate`.", "enum": [ "US Interstate Property", "US Interstate Passenger", "Texas Intrastate" ], "example": "US Interstate Property", "type": "string" }, "DriverEldRulesetUpdatedAtTime": { "description": "The date and time this driver ELD ruleset was last updated in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "DriverEldRulesetUsShortHaulType": { "description": "The US short haul ruleset type of the ELD ruleset applied to this driver.", "enum": [ "100 Air-Mile (Passenger)", "100 Air-Mile (Property)", "150 Air-Mile (Non-CDL)" ], "example": "100 Air-Mile (Passenger)", "type": "string" }, "DriverEldRulesets": { "description": "The driver's ELD rulesets and overrides. This is the full set of rulesets that may apply to the driver depending on their activity. If you wish to interface with the specific US driver override, use the usDriverRulesetOverride field.", "items": { "$ref": "#/components/schemas/DriverEldRuleset" }, "type": "array" }, "DriverEldSettings": { "description": "The driver's ELD settings.", "properties": { "rulesets": { "$ref": "#/components/schemas/DriverEldRulesets" } }, "type": "object" }, "DriverEldYmEnabled": { "default": false, "description": "Flag indicating this driver may select the Yard Move duty status in ELD logs.", "type": "boolean" }, "DriverExternalIds": { "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "DriverHasDrivingFeaturesHidden": { "description": "A boolean indicating whether the driver has driving-related features hidden in the Driver App, including Vehicle selection, HOS, Routing, Team Driving, Documents, and Trip Logs. Default value is false if omitted. Note: only available to customers of Connected Forms.", "example": true, "type": "boolean" }, "DriverHeavyHaulExemptionToggleEnabled": { "default": false, "description": "Flag indicating this driver may use the Heavy Haul exemption in ELD logs.", "type": "boolean" }, "DriverHomeTerminalAddress": { "description": "Address of the place of business at which a driver ordinarily reports for work.", "example": "1234 Pear St., Scranton, PA 62814", "maxLength": 255, "type": "string" }, "DriverHomeTerminalName": { "description": "Name of the place of business at which a driver ordinarily reports for work.", "example": "Acme Inc.", "maxLength": 255, "type": "string" }, "DriverHosSetting": { "description": "Hos settings for a driver.", "properties": { "heavyHaulExemptionToggleEnabled": { "$ref": "#/components/schemas/DriverHeavyHaulExemptionToggleEnabled" } }, "type": "object" }, "DriverId": { "description": "Samsara ID for the driver.", "example": "123", "type": "string" }, "DriverIdCardCode": { "description": "The ID Card Code on the back of the physical card assigned to the driver. Contact Samsara if you would like to enable this feature.", "example": "941767043", "type": "string" }, "DriverIsDeactivated": { "description": "[DEPRECATED] A boolean indicating whether or not the driver is deactivated. Use `driverActivationStatus` instead.", "example": false, "type": "boolean" }, "DriverLicenseNumber": { "description": "Driver's state issued license number. The combination of this number and `licenseState` must be unique.", "example": "E1234567", "type": "string" }, "DriverLicenseState": { "description": "Abbreviation of US state, Canadian province, or US territory that issued driver's license.", "example": "CA", "type": "string" }, "DriverLocale": { "description": "Locale override (uncommon). These are specified by ISO 3166-2 country codes for supported locales. Valid values: `us`, `at`, `be`, `ca`, `gb`, `fr`, `de`, `ie`, `it`, `lu`, `mx`, `nl`, `es`, `ch`, `pr`.", "enum": [ "us", "at", "be", "ca", "gb", "fr", "de", "ie", "it", "lu", "mx", "nl", "es", "ch", "pr" ], "type": "string" }, "DriverMainOfficeAddress": { "description": "Main office address for a given driver. If this differs from the general organization's settings, the override value is used. ", "example": "1234 Pear St., Scranton, PA 62814", "maxLength": 255, "type": "string" }, "DriverMessageReceivedResponseBody": { "description": "Details specific to Driver Message Received.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" } }, "type": "object" }, "DriverMessageSentResponseBody": { "description": "Details specific to Driver Message Sent.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" } }, "type": "object" }, "DriverName": { "description": "Driver's name.", "example": "Susan Jones", "maxLength": 255, "minLength": 1, "type": "string" }, "DriverNotes": { "description": "Notes about the driver.", "example": "Also goes by the nickname Furious Fred.", "maxLength": 4096, "type": "string" }, "DriverObjectResponseBody": { "description": "Current driver of the vehicle. Note: this parameter includes all assignment sources, not just static assignments.", "properties": { "id": { "description": "ID of the driver.", "example": "0987", "type": "string" }, "name": { "description": "Name of the driver.", "example": "Driver Name", "type": "string" } }, "type": "object" }, "DriverPassword": { "description": "Password that the driver can use to login to the Samsara driver app.", "example": "aSecurePassword1234", "type": "string" }, "DriverPhone": { "description": "Phone number of the driver.", "example": "5558234327", "maxLength": 255, "type": "string" }, "DriverQrCodesCreateDriverQrCodeBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeRequestBody": { "description": "Driver to assign a new QR code to.", "properties": { "driverId": { "description": "Unique ID of the driver.", "example": 494123, "format": "int64", "type": "integer" } }, "required": [ "driverId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/QrCodeResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesCreateDriverQrCodeUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeRequestBody": { "description": "Driver to revoke active QR code from.", "properties": { "driverId": { "description": "Unique ID of the driver.", "example": 494123, "format": "int64", "type": "integer" } }, "required": [ "driverId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesDeleteDriverQrCodeUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesResponseBody": { "properties": { "data": { "description": "List of driver QR codes.", "items": { "$ref": "#/components/schemas/QrCodeResponseObjectResponseBody" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverQrCodesGetDriversQrCodesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRecordedResponseBody": { "description": "Details specific to Driver Recorded.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutRequestBody": { "description": "The driver of a vehicle.", "properties": { "driverId": { "description": "ID of the driver.", "example": "12434", "type": "string" } }, "required": [ "driverId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutResponseBody": { "properties": { "driverName": { "description": "The name of the driver", "example": "Michael", "type": "string" } }, "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverRemoteSignoutPostDriverRemoteSignoutUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverResponse": { "description": "A single driver.", "properties": { "data": { "$ref": "#/components/schemas/Driver" } }, "type": "object" }, "DriverRulesetObjectResponseBody": { "properties": { "break": { "description": "The rest break required setting of the ELD ruleset applied to this driver. Valid values: `Property (off-duty/sleeper)`, `Explosives/HazMat (on-duty)`", "enum": [ "Property (off-duty/sleeper)", "Explosives/HazMat (on-duty)" ], "example": "Explosives/HazMat (on-duty)", "type": "string" }, "cycle": { "description": "The cycle of the ELD ruleset applied to this driver. Valid values: `USA 60 hour / 7 day`, `USA 70 hour / 8 day`, `AK 80 hour / 8 day`, `AK 70 hour / 7 day`, `CA 80 hour / 8 day`, `CA 112 hour / 8 day`, `FL 80 hour / 8 day`, `FL 70 hour / 7 day`, `NE 80 hour / 8 day`, `NE 70 hour / 7 day`, `NC 80 hour / 8 day`, `NC 70 hour / 7 day`, `OK 70 hour / 8 day`, `OK 60 hour / 7 day`, `OR 80 hour / 8 day`, `OR 70 hour / 7 day`, `SC 80 hour / 8 day`, `SC 70 hour / 7 day`, `TX 70 hour / 7 day`, `WI 80 hour / 8 day`, `WI 70 hour / 7 day`, `Canada South Cycle 1 (70 hour / 7 day)`, `Canada South Cycle 2 (120 hour / 14 day)`, `Canada North Cycle 1 (80 hour / 7 day)`, `Canada North Cycle 2 (120 hour / 14 day)`", "enum": [ "USA 60 hour / 7 day", "USA 70 hour / 8 day", "AK 80 hour / 8 day", "AK 70 hour / 7 day", "CA 80 hour / 8 day", "CA 112 hour / 8 day", "FL 80 hour / 8 day", "FL 70 hour / 7 day", "NE 80 hour / 8 day", "NE 70 hour / 7 day", "NC 80 hour / 8 day", "NC 70 hour / 7 day", "OK 70 hour / 8 day", "OK 60 hour / 7 day", "OR 80 hour / 8 day", "OR 70 hour / 7 day", "SC 80 hour / 8 day", "SC 70 hour / 7 day", "TX 70 hour / 7 day", "WI 80 hour / 8 day", "WI 70 hour / 7 day", "Canada South Cycle 1 (70 hour / 7 day)", "Canada South Cycle 2 (120 hour / 14 day)", "Canada North Cycle 1 (80 hour / 7 day)", "Canada North Cycle 2 (120 hour / 14 day)" ], "example": "USA 60 hour / 7 day", "type": "string" }, "jurisdiction": { "description": "The jurisdiction of the ELD ruleset applied to this driver. These are specified by either `CS` or `CN` for Canada South and Canada North, respectively, or the ISO 3166-2 postal code for the supported state or territory.", "example": "AR", "type": "string" }, "restart": { "description": "The restart of the ELD ruleset applied to this driver. Valid values: `34-hour Restart`, `24-hour Restart`, `36-hour Restart`, `72-hour Restart`", "enum": [ "34-hour Restart", "24-hour Restart", "36-hour Restart", "72-hour Restart" ], "example": "34-hour Restart", "type": "string" }, "shift": { "description": "The shift of the ELD ruleset applied to this driver. Valid values: `US Interstate Property`, `US Interstate Passenger`", "enum": [ "US Interstate Property", "US Interstate Passenger" ], "example": "US Interstate Property", "type": "string" } }, "type": "object" }, "DriverStaticAssignedVehicle": { "description": "Vehicle assigned to the driver for static vehicle assignments. (uncommon).", "properties": { "id": { "description": "ID of the vehicle.", "example": "123456789", "type": "string" }, "name": { "description": "Name of the vehicle.", "example": "Midwest Truck #4", "type": "string" } }, "type": "object" }, "DriverStaticAssignedVehicleId": { "description": "ID of vehicle that the driver is permanently assigned to. (uncommon).", "example": "456", "type": "string" }, "DriverTachographActivityData": { "items": { "$ref": "#/components/schemas/TachographActivityListWrapper" }, "type": "array" }, "DriverTachographActivityResponse": { "description": "List of all driver tachograph activities in a specified time range.", "properties": { "data": { "$ref": "#/components/schemas/DriverTachographActivityData" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "DriverTachographCardNumber": { "description": "Driver's assigned tachograph card number (Europe specific)", "example": "1000000492436002", "type": "string" }, "DriverTagIds": { "description": "IDs of tags the driver is associated with.", "items": { "example": "147", "type": "string" }, "type": "array" }, "DriverTags": { "description": "The tags this driver belongs to.", "items": { "$ref": "#/components/schemas/tagTinyResponse" }, "type": "array" }, "DriverTimezone": { "default": "America/Los_Angeles", "description": "Home terminal timezone, in order to indicate what time zone should be used to calculate the ELD logs. Driver timezones use [IANA timezone database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`, `America/New_York`, `Europe/London`, etc.). You can find a mapping of common timezone formats to IANA timezone keys [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).", "example": "America/Los_Angeles", "type": "string" }, "DriverUpdatedAtTime": { "description": "The date and time this driver was last updated in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "DriverUsername": { "description": "Driver's login username into the driver app. The username may not contain spaces or the '@' symbol. The username must be unique.", "example": "SusanJones", "maxLength": 189, "minLength": 1, "type": "string" }, "DriverVehicleAssignmentV2ObjectResponseBody": { "description": "Object with driver assignment info and associated driver and vehicle info.", "properties": { "assignedAtTime": { "description": " An assigned at time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "assignmentType": { "description": "Name of the assigning source for the driver assignment record. Valid values: `invalid`, `unknown`, `HOS`, `idCard`, `static`, `faceId`, `tachograph`, `safetyManual`, `RFID`, `trailer`, `external`, `qrCode`", "enum": [ "invalid", "unknown", "HOS", "idCard", "static", "faceId", "tachograph", "safetyManual", "RFID", "trailer", "external", "qrCode" ], "example": "idCard", "type": "string" }, "driver": { "$ref": "#/components/schemas/GoaDriverTinyResponseResponseBody" }, "endTime": { "description": " An end time in RFC 3339 format. Omitted if not applicable. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "isPassenger": { "description": "Boolean indicating whether the driver is a passenger.", "example": false, "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/DriverAssignmentMetadataTinyObjectResponseBody" }, "startTime": { "description": " A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/GoaVehicleTinyResponseResponseBody" } }, "required": [ "driver", "isPassenger", "startTime", "vehicle" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody": { "description": "Driver Assignment to be created", "properties": { "assignedAtTime": { "description": "The time at which the assignment was made in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "driverId": { "description": "ID of the driver. This can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the driver.", "example": "494123", "type": "string" }, "endTime": { "description": "The end time in RFC 3339 format. Defaults to max-time (meaning it's an ongoing assignment) if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "isPassenger": { "description": "Is this driver a passenger? Defaults to false if not provided", "example": true, "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/PostDriverVehicleAssignmentsV2RequestBodyMetadataRequestBody" }, "startTime": { "description": "The start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "vehicleId": { "description": "ID of the vehicle. This can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the vehicle.", "example": "281474978683353", "type": "string" } }, "required": [ "driverId", "vehicleId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PostDriverVehicleAssignmentsV2ResponseBodyResponseBody" } }, "required": [ "data" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody": { "description": "Driver assignments to be deleted", "properties": { "assignedAtTime": { "description": " Assigned at time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "endTime": { "description": " An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "isPassenger": { "description": "Indicates if assigned driver is passenger", "example": true, "type": "boolean" }, "startTime": { "description": " A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "vehicleId": { "description": "ID of the vehicle. This can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the vehicle.", "example": "281474978683353", "type": "string" } }, "required": [ "vehicleId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsResponseBody": { "properties": { "data": { "description": "List of driver assignment objects and their respective vehcile and driver info.", "items": { "$ref": "#/components/schemas/DriverVehicleAssignmentV2ObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody": { "description": "Updated Driver Assignment details", "properties": { "assignedAtTime": { "description": "The time at which the assignment was made in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "driverId": { "description": "ID of the driver. This can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the driver.", "example": "494123", "type": "string" }, "endTime": { "description": "The end time in RFC 3339 format. To make this an ongoing assignment (ie. an assignment with no end time), provide an endTime value of 'null'. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "isPassenger": { "description": "Is this driver a passenger?", "example": true, "type": "boolean" }, "metadata": { "$ref": "#/components/schemas/PatchDriverVehicleAssignmentsV2RequestBodyMetadataRequestBody" }, "startTime": { "description": "The start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "vehicleId": { "description": "ID of the vehicle. This can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the vehicle.", "example": "281474978683353", "type": "string" } }, "required": [ "driverId", "startTime", "vehicleId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PatchDriverVehicleAssignmentsV2ResponseBodyResponseBody" } }, "required": [ "data" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriverVehicleGroupTag": { "description": "Tag which determines which vehicles a driver will see when selecting vehicles.", "properties": { "id": { "description": "ID of the tag.", "example": "3914", "type": "string" }, "name": { "description": "Name of the tag.", "example": "East Coast", "type": "string" }, "parentTagId": { "description": "If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.", "example": "4815", "type": "string" } }, "type": "object" }, "DriverVehicleGroupTagId": { "description": "Tag ID which determines which vehicles a driver will see when selecting vehicles.", "example": "342417", "type": "string" }, "DriverWaitingTimeDutyStatusEnabled": { "default": false, "description": "Flag indicating this driver may select waiting time duty status in ELD logs.", "type": "boolean" }, "DriverWithExternalIdObjectResponseBody": { "description": "A driver object with an id and map of external ids.", "properties": { "driverId": { "description": "Samsara ID of the driver.", "example": "0987", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" } }, "required": [ "driverId" ], "type": "object" }, "DriverWithTimezoneEldSettingsObjectResponseBody": { "description": "The driver the log applies to.", "properties": { "eldSettings": { "$ref": "#/components/schemas/EldSettingsObjectResponseBody" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the driver", "example": "45646", "type": "string" }, "name": { "description": "Name of the driver", "example": "Driver Bob", "type": "string" }, "timezone": { "default": "America/Los_Angeles", "description": "Home terminal timezone, in order to indicate what time zone should be used to calculate the ELD logs. Driver timezones use [IANA timezone database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`, `America/New_York`, `Europe/London`, etc.). You can find a mapping of common timezone formats to IANA timezone keys [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).", "example": "America/Los_Angeles", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsResponseBody": { "properties": { "data": { "description": "List of driver and their vehicle assignments.", "items": { "$ref": "#/components/schemas/DriversVehicleAssignmentsObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsGetDriversVehicleAssignmentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DriversVehicleAssignmentsObjectResponseBody": { "properties": { "driverActivationStatus": { "description": "A value indicating whether the driver is active or deactivated. Valid values: `active`, `deactivated`", "enum": [ "active", "deactivated" ], "example": "active", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the driver.", "example": "494123", "type": "string" }, "name": { "description": "Name of the driver.", "example": "Joe Driver", "type": "string" }, "vehicleAssignments": { "description": "List of vehicle assignment objects.", "items": { "$ref": "#/components/schemas/VehicleAssignmentObjectResponseBody" }, "type": "array" } }, "required": [ "driverActivationStatus", "id", "name", "vehicleAssignments" ], "type": "object" }, "DutyStatusDurationObjectResponseBody": { "description": "The currently applied duty status durations on the driver's log.", "properties": { "activeDurationMs": { "description": "Duration the driver was active for in the log period in milliseconds.", "example": 38825000, "format": "int64", "type": "integer" }, "driveDurationMs": { "description": "Duration the driver was driving for in the log period in milliseconds.", "example": 31970000, "format": "int64", "type": "integer" }, "offDutyDurationMs": { "description": "Duration the driver was off duty for in the log period in milliseconds.", "example": 20555000, "format": "int64", "type": "integer" }, "onDutyDurationMs": { "description": "Duration the driver was on duty for in the log period in milliseconds.", "example": 5423000, "format": "int64", "type": "integer" }, "personalConveyanceDurationMs": { "description": "Duration the driver was driving for personal conveyance for in the log period in milliseconds.", "example": 4358000, "format": "int64", "type": "integer" }, "sleeperBerthDurationMs": { "description": "Duration the driver was in their sleeper berth for in the log period in milliseconds.", "example": 27020000, "format": "int64", "type": "integer" }, "waitingTimeDurationMs": { "description": "Duration the driver was waiting for in the log period in milliseconds.", "example": 1560000, "format": "int64", "type": "integer" }, "yardMoveDurationMs": { "description": "Duration the driver was driving for yard moves for in the log period in milliseconds.", "example": 1432000, "format": "int64", "type": "integer" } }, "type": "object" }, "Dvir": { "description": "Information about a DVIR.", "properties": { "authorSignature": { "$ref": "#/components/schemas/DvirAuthorSignature" }, "endTime": { "description": "Time when driver signed and completed this DVIR. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "id": { "description": "Unique Samsara ID for the DVIR.", "example": "7107471", "type": "string" }, "licensePlate": { "$ref": "#/components/schemas/DvirLicensePlate" }, "location": { "$ref": "#/components/schemas/DvirLocation" }, "mechanicNotes": { "$ref": "#/components/schemas/DvirMechanicNotes" }, "odometerMeters": { "$ref": "#/components/schemas/DvirOdometerMeters" }, "safetyStatus": { "default": "unsafe", "description": "The condition of vehicle on which DVIR was done. Valid values: `safe`, `unsafe`, `resolved`.", "enum": [ "safe", "unsafe", "resolved" ], "example": "unsafe", "type": "string" }, "secondSignature": { "$ref": "#/components/schemas/DvirSecondSignature" }, "startTime": { "description": "Time when driver began filling out this DVIR. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "thirdSignature": { "$ref": "#/components/schemas/DvirThirdSignature" }, "trailer": { "$ref": "#/components/schemas/DvirTrailer" }, "trailerDefects": { "$ref": "#/components/schemas/DvirTrailerDefects" }, "trailerName": { "description": "The name of the trailer the DVIR was submitted for. Only included for tractor+trailer DVIRs.", "example": "Midwest Trailer #5", "type": "string" }, "type": { "default": "unspecified", "description": "Inspection type of the DVIR. Valid values: `preTrip`, `postTrip`, `mechanic`, `unspecified`.", "enum": [ "preTrip", "postTrip", "mechanic", "unspecified" ], "example": "preTrip", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/DvirVehicle" }, "vehicleDefects": { "$ref": "#/components/schemas/DvirVehicleDefects" } }, "required": [ "id" ], "type": "object" }, "DvirAuthorSignature": { "allOf": [ { "description": "An author signature object which has a signatory mini object with the signed time. Author Signature.", "type": "object" }, { "$ref": "#/components/schemas/DvirSignature" } ] }, "DvirDefectStreamDefectsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectStreamDefectsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectStreamDefectsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectStreamDefectsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectStreamDefectsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectStreamDefectsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectStreamDefectsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectStreamDefectsResponseBody": { "properties": { "data": { "description": "List of DVIR defects.", "items": { "$ref": "#/components/schemas/DefectsResponseDataResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DvirDefectStreamDefectsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectStreamDefectsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectStreamDefectsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesResponseBody": { "properties": { "data": { "description": "List of defect types.", "items": { "$ref": "#/components/schemas/DefectTypesResponseDataResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DvirDefectTypeGetDefectTypesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectTypeGetDefectTypesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirDefectsObject_v2022_09_13ResponseBody": { "description": "A description of a DVIR defect", "properties": { "comment": { "description": "Comment on the defect.", "example": "Air compressor not working", "type": "string" }, "createdAtTime": { "description": "Time when the defect was created. UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "defectType": { "description": "The type of DVIR defect.", "example": "Air Compressor", "type": "string" }, "id": { "description": "The ID of the defect.", "example": "18", "type": "string" }, "isResolved": { "description": "Signifies if this defect is resolved.", "example": false, "type": "boolean" }, "mechanicNotes": { "description": "The mechanic notes on this defect.", "example": "Extremely large oddly shaped hole in passenger side window.", "type": "string" }, "mechanicNotesUpdatedAtTime": { "description": "Time when mechanic notes were last updated. UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "resolvedAtTime": { "description": "Time when this defect was resolved. Will not be returned if the defect is unresolved. UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "resolvedBy": { "$ref": "#/components/schemas/DvirResolvedByObjectResponseBody" }, "trailer": { "$ref": "#/components/schemas/GoaTrailerTinyResponseResponseBody" }, "vehicle": { "$ref": "#/components/schemas/VehicleWithGatewayTinyResponseResponseBody" } }, "required": [ "createdAtTime", "defectType", "id", "isResolved" ], "type": "object" }, "DvirGetDvirsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirGetDvirsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirGetDvirsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirGetDvirsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirGetDvirsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirGetDvirsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirGetDvirsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirGetDvirsResponseBody": { "properties": { "data": { "items": { "$ref": "#/components/schemas/DvirStreamResponseDataResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "DvirGetDvirsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirGetDvirsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirGetDvirsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "DvirLicensePlate": { "description": "The license plate of this vehicle.", "example": "XHK1234", "maxLength": 12, "type": "string" }, "DvirLocation": { "description": "Optional string if your jurisdiction requires a location of the DVIR.", "example": "350 Rhode Island St Ste. 400S, San Francisco, CA 94103", "type": "string" }, "DvirMechanicNotes": { "description": "The mechanics notes on the DVIR.", "example": "Replaced headlight on passenger side.", "type": "string" }, "DvirOdometerMeters": { "description": "The odometer reading in meters.", "example": 14010293, "type": "integer" }, "DvirResolvedByObjectResponseBody": { "description": "The person who resolved this defect.", "properties": { "id": { "description": "ID of the entity that resolved this defect. If the defect was resolved by a driver, this will be a Samsara Driver ID. If the defect was resolved by a mechanic, this will be the Samsara Dashboard User ID of the mechanic.", "example": "8172", "type": "string" }, "name": { "description": "Name of the person who resolved this defect.", "example": "Jane Mechanic", "type": "string" }, "type": { "description": "Indicates whether this defect was resolved by a driver or a mechanic. Valid values: `driver`, `mechanic`", "enum": [ "driver", "mechanic" ], "example": "mechanic", "type": "string" } }, "required": [ "id", "name", "type" ], "type": "object" }, "DvirResponse": { "description": "The DVIR response.", "properties": { "data": { "$ref": "#/components/schemas/Dvir" } }, "type": "object" }, "DvirSecondSignature": { "allOf": [ { "description": "An author signature object which has a signatory mini object with the signed time. Second Signature.", "type": "object" }, { "$ref": "#/components/schemas/DvirSignature" } ] }, "DvirSignature": { "description": "DVIR Signure.", "properties": { "signatoryUser": { "allOf": [ { "description": "The user who signed the DVIR.", "type": "object" }, { "$ref": "#/components/schemas/userTinyResponse" } ], "type": "object" }, "signedAtTime": { "description": "The time when the DVIR was signed. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "type": { "default": "driver", "description": "Whether the DVIR was submitted by a `driver` or `mechanic`. Valid values: `driver`, `mechanic`.", "enum": [ "driver", "mechanic" ], "example": "driver", "type": "string" } }, "type": "object" }, "DvirStreamResponseDataResponseBody": { "properties": { "authorSignature": { "$ref": "#/components/schemas/AuthorSignatureObjectResponseBody" }, "defectIds": { "description": "IDs of defects registered for the DVIR.", "example": [ "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "25d6151e-29b5-453e-875a-7c5425332e09" ], "items": { "example": "Consequuntur ut expedita.", "type": "string" }, "type": "array" }, "dvirSubmissionBeginTime": { "description": "Time when driver created DVIR. UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "dvirSubmissionTime": { "description": "Time when driver submitted the DVIR. UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "formattedAddress": { "example": "350 Rhode Island St Ste. 400S, San Francisco, CA 94103", "type": "string" }, "id": { "description": "The unique id of the DVIR", "example": "12345", "type": "string" }, "mechanicNotes": { "description": "The mechanics notes on the DVIR.", "example": "Replaced headlight on passenger side.", "type": "string" }, "odometerMeters": { "description": "The odometer reading in meters.", "example": 91823, "format": "int64", "type": "integer" }, "safetyStatus": { "description": "The condition of vehicle on which DVIR was done. Valid values: `unknown`, `safe`, `unsafe`, `resolved`", "enum": [ "unknown", "safe", "unsafe", "resolved" ], "example": "unsafe", "type": "string" }, "secondSignature": { "$ref": "#/components/schemas/AuthorSignatureObjectResponseBody" }, "thirdSignature": { "$ref": "#/components/schemas/AuthorSignatureObjectResponseBody" }, "trailer": { "$ref": "#/components/schemas/TrailerDvirObjectResponseBody" }, "type": { "description": "Inspection type of the DVIR. Valid values: `preTrip`, `postTrip`, `mechanic`, `unspecified`", "enum": [ "preTrip", "postTrip", "mechanic", "unspecified" ], "example": "mechanic", "type": "string" }, "updatedAtTime": { "description": "Time of any DVIR updates. UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/VehicleDvirObjectResponseBody" }, "walkaroundPhotos": { "description": "List of walkaround photos", "items": { "$ref": "#/components/schemas/WalkaroundPhotoObjectResponseBody" }, "type": "array" } }, "required": [ "authorSignature", "dvirSubmissionBeginTime", "dvirSubmissionTime", "id", "type", "updatedAtTime" ], "type": "object" }, "DvirThirdSignature": { "allOf": [ { "description": "An author signature object which has a signatory mini object with the signed time. Third Signature.", "type": "object" }, { "$ref": "#/components/schemas/DvirSignature" } ] }, "DvirTrailer": { "allOf": [ { "description": "The trailer the DVIR was submitted for. Only included for trailer only DVIRs.", "type": "object" }, { "$ref": "#/components/schemas/trailerTinyResponse" } ] }, "DvirTrailerDefects": { "description": "Defects registered for the trailer which was part of the DVIR.", "items": { "$ref": "#/components/schemas/dvirTrailerDefectsItems" }, "type": "array" }, "DvirVehicle": { "allOf": [ { "description": "The vehicle the DVIR was submitted for. Only included for tractor or tractor+trailer DVIRs.", "type": "object" }, { "$ref": "#/components/schemas/vehicleTinyResponse" } ] }, "DvirVehicleDefects": { "description": "Defects registered for the vehicle which was part of the DVIR.", "items": { "$ref": "#/components/schemas/dvirTrailerDefectsItems" }, "type": "array" }, "DvirsListResponse": { "description": "A list of DVIRs and pagination information.", "properties": { "data": { "description": "A list of DVIRs.", "items": { "$ref": "#/components/schemas/Dvir" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "EldSettingsObjectResponseBody": { "description": "The driver's ELD settings.", "properties": { "rulesets": { "description": "The driver's ELD rulesets and overrides.", "items": { "$ref": "#/components/schemas/DriverRulesetObjectResponseBody" }, "type": "array" } }, "type": "object" }, "EngineIdleDataResponseBody": { "description": "Details specific to Engine Idle.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "EngineIdleTriggerDetailsObjectRequestBody": { "description": "Details specific to Engine Idle", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "EngineIdleTriggerDetailsObjectResponseBody": { "description": "Details specific to Engine Idle", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesResponseBody": { "properties": { "data": { "description": "A list of engine immobilizer states in ascending order of happenedAtTime.", "items": { "$ref": "#/components/schemas/EngineImmobilizerStateResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerGetEngineImmobilizerStatesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerRelayStateResponseBody": { "description": "An engine immobilizer relay state.", "properties": { "id": { "description": "The ID of the relay Valid values: `relay1`, `relay2`", "enum": [ "relay1", "relay2" ], "example": "relay1", "type": "string" }, "isOpen": { "description": "Whether the relay is open.", "example": false, "type": "boolean" } }, "required": [ "id", "isOpen" ], "type": "object" }, "EngineImmobilizerStateResponseBody": { "description": "An engine immobilizer state.", "properties": { "happenedAtTime": { "description": "A UTC time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "isConnectedToVehicle": { "description": "Whether the engine immobilizer is connected the vehicle.", "example": true, "type": "boolean" }, "relayStates": { "description": "A list of states for each relay", "items": { "$ref": "#/components/schemas/EngineImmobilizerRelayStateResponseBody" }, "type": "array" }, "vehicleId": { "description": "The ID of the vehicle that the engine immobilizer is connected to.", "example": "1234", "type": "string" } }, "required": [ "happenedAtTime", "isConnectedToVehicle", "relayStates", "vehicleId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateRequestBody": { "description": "A request body to update the engine immobilizer state.", "properties": { "relayStates": { "description": "A list of relay states. If a relay is omitted, its state won't be updated. If the list is empty, a 400 bad request status code will be returned. If there are multiple states for the same relay, a 400 bad request status code will be returned.", "items": { "$ref": "#/components/schemas/UpdateEngineImmobilizerRelayStateRequestBodyRequestBody" }, "type": "array" } }, "required": [ "relayStates" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineImmobilizerUpdateEngineImmobilizerStateUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EngineOffDetailsObjectRequestBody": { "description": "Details specific to Engine Off", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "EngineOffDetailsObjectResponseBody": { "description": "Details specific to Engine Off", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "EngineOffResponseBody": { "description": "Details specific to Engine Off.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "EngineOnDetailsObjectRequestBody": { "description": "Details specific to Engine On", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "EngineOnDetailsObjectResponseBody": { "description": "Details specific to Engine On", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "EngineOnResponseBody": { "description": "Details specific to Engine On.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "EngineStatusResponseBody": { "description": "Equipment engine status.", "properties": { "Running": { "description": "Boolean value for whether engine is running or not.", "example": true, "type": "boolean" }, "datetime": { "description": "Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "Equipment": { "description": "An equipment object.", "properties": { "assetSerial": { "description": "An equipment identification number.", "example": "1FUJA6BD31LJ09646", "type": "string" }, "externalIds": { "$ref": "#/components/schemas/carrierProposedAssignmentDriverAllOf2ExternalIds" }, "id": { "$ref": "#/components/schemas/EquipmentId" }, "installedGateway": { "$ref": "#/components/schemas/Equipment_installedGateway" }, "name": { "$ref": "#/components/schemas/EquipmentName" }, "notes": { "description": "Notes about a piece of equipment. Samsara supports a maximum of 255 chars.", "example": "These are notes about this given equipment.", "maxLength": 255, "type": "string" }, "tags": { "description": "An array of all tag mini-objects that are associated with the given equipment.", "items": { "$ref": "#/components/schemas/tagTinyResponse" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "EquipmentEngineRpm": { "description": "Engine RPM reading.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "The revolutions per minute of the engine.", "example": 1800, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentEngineSeconds": { "description": "[DEPRECATED] Please use either `gatewayEngineSeconds` or `obdEngineSeconds`.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power and an offset provided manually through the Samsara cloud dashboard.", "example": 22374000, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentEngineState": { "description": "[DEPRECATED] Please use either `gatewayEngineStates` or `obdEngineStates`.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Valid values: `Off`, `On`.", "enum": [ "Off", "On" ], "example": "On", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentEngineTotalIdleTimeMinutes": { "description": "A time-series of engine total idle time minutes. (Beta)", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "Total time in minutes that the engine has been idling since the device was installed. This value is calculated based on the time the engine has been running while the vehicle is not in motion.", "example": 1000, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentFuelPercent": { "description": "Fuel percent reading.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "The percent of fuel in the unit of equipment.", "example": 54, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentGatewayEngineSeconds": { "description": "Engine seconds reading from the aux/digio cable.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power and an offset provided manually through the Samsara cloud dashboard.", "example": 22374000, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentGatewayEngineState": { "description": "Engine state reading from the aux/digio cable.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Valid values: `Off`, `On`.", "enum": [ "Off", "On" ], "example": "On", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentGatewayJ1939EngineSeconds": { "description": "Engine seconds reading from the J1939/CAT cable.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power and an offset provided manually through the Samsara cloud dashboard.", "example": 22374000, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentGpsOdometerMeters": { "description": "GPS odometer reading.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard.", "example": 3200, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentHeaderWithAdditionalFieldsResponseBody": { "description": "Equipment header fields.", "properties": { "EquipmentID": { "description": "The unique Samsara ID of the equipment. This is automatically generated when the Equipment object is created. It cannot be changed.", "example": "494123", "type": "string" }, "Model": { "description": "The model of the equipment.", "example": "S630 T4", "type": "string" }, "OEMName": { "description": "The make of the equipment.", "example": "Bobcat", "type": "string" }, "PIN": { "description": "The PIN number of the equipment.", "example": "8V8WD530FLN016251", "type": "string" }, "SerialNumber": { "description": "The serial number of the equipment.", "example": "8V8WD530FLN016251", "type": "string" }, "UnitInstallDateTime": { "description": "Telematics unit install date in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "EquipmentId": { "description": "Unique Samsara ID for the equipment.", "example": "112", "type": "string" }, "EquipmentListResponse": { "description": "List of all equipment objects, and pagination information.", "properties": { "data": { "description": "List of equipment objects.", "items": { "$ref": "#/components/schemas/Equipment" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "EquipmentLocation": { "description": "Location reading.", "properties": { "heading": { "description": "Heading of the unit of equipment in degrees.", "example": 120, "format": "double", "type": "number" }, "latitude": { "description": "GPS latitude represented in degrees", "example": 122.142, "format": "double", "type": "number" }, "longitude": { "description": "GPS longitude represented in degrees", "example": -93.343, "format": "double", "type": "number" }, "speed": { "description": "GPS speed of the unit of equipment in miles per hour.", "example": 48.3, "format": "double", "type": "number" }, "time": { "$ref": "#/components/schemas/time" } }, "required": [ "latitude", "longitude", "time" ], "type": "object" }, "EquipmentLocationsListResponse": { "description": "A time-series of equipment locations and pagination information", "properties": { "data": { "description": "Time-series of locations for the specified units of equipment.", "items": { "$ref": "#/components/schemas/EquipmentLocationsListResponse_data" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "EquipmentLocationsListResponse_data": { "description": "A unit of equipment and its time-series of location events.", "properties": { "id": { "$ref": "#/components/schemas/EquipmentId" }, "locations": { "description": "A time-series of location events for the given unit of equipment.", "items": { "$ref": "#/components/schemas/EquipmentLocation" }, "type": "array" }, "name": { "$ref": "#/components/schemas/EquipmentName" } }, "required": [ "id", "locations", "name" ], "type": "object" }, "EquipmentLocationsResponse": { "description": "The most recent equipment locations and pagination information", "properties": { "data": { "description": "List of the most recent locations for the specified units of equipment.", "items": { "$ref": "#/components/schemas/EquipmentLocationsResponse_data" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "EquipmentLocationsResponse_data": { "description": "A unit of equipment and its most recent location.", "properties": { "id": { "$ref": "#/components/schemas/EquipmentId" }, "location": { "$ref": "#/components/schemas/EquipmentLocation" }, "name": { "$ref": "#/components/schemas/EquipmentName" } }, "required": [ "id", "location", "name" ], "type": "object" }, "EquipmentName": { "description": "Name of the equipment.", "example": "Crane A7", "type": "string" }, "EquipmentObdEngineSeconds": { "description": "Engine seconds reading from on-board diagnostics.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics.", "example": 22374000, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentObdEngineState": { "description": "Engine state reading from on-board diagnostics.", "properties": { "time": { "$ref": "#/components/schemas/EquipmentTime" }, "value": { "description": "The state of the engine read from on-board diagnostics. Valid values: `Off`, `On`, `Idle`.", "enum": [ "Off", "On", "Idle" ], "example": "On", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "EquipmentPatchEquipmentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentPatchEquipmentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentPatchEquipmentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentPatchEquipmentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentPatchEquipmentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentPatchEquipmentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentPatchEquipmentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentPatchEquipmentRequestBody": { "properties": { "attributes": { "description": "List of attributes associated with the entity", "items": { "$ref": "#/components/schemas/GoaAttributeTiny" }, "type": "array" }, "engineHours": { "description": "When you provide a manual engine hours override, Samsara will begin updating a equipment's engine hours used since this override was set.", "example": 1234, "format": "int64", "type": "integer" }, "equipmentSerialNumber": { "description": "The serial number of the equipment.", "example": "8V8WD530FLN016251", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed.", "example": "494123", "type": "string" }, "name": { "description": "The human-readable name of the Equipment. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Equipment-123", "type": "string" }, "notes": { "description": "These are generic notes about the Equipment. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are my equipment notes", "maxLength": 255, "type": "string" }, "odometerMeters": { "description": "When you provide a manual odometer override, Samsara will begin updating a equipment's odometer using GPS distance traveled since this override was set.", "example": 1234, "format": "int64", "type": "integer" }, "tagIds": { "description": "An array of IDs of tags to associate with this equipment. If your access to the API is scoped by one or more tags, this field is required to pass in. ", "example": [ "Porro dolor provident consequatur est.", "Aperiam consequatur laborum magnam illum a veniam." ], "items": { "example": "Corporis aut quas.", "type": "string" }, "type": "array" } }, "type": "object" }, "EquipmentPatchEquipmentResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/EquipmentWithAttributesResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "EquipmentPatchEquipmentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentPatchEquipmentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentPatchEquipmentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "EquipmentResponse": { "description": "A response containing an equipment object.", "properties": { "data": { "$ref": "#/components/schemas/Equipment" } }, "required": [ "data" ], "type": "object" }, "EquipmentStatsGps": { "description": "GPS location of equipment.", "properties": { "address": { "$ref": "#/components/schemas/addressTinyResponse" }, "headingDegrees": { "$ref": "#/components/schemas/AssetLocationHeading" }, "latitude": { "description": "GPS latitude represented in degrees", "example": 122.142, "format": "double", "type": "number" }, "longitude": { "description": "GPS longitude represented in degrees", "example": -93.343, "format": "double", "type": "number" }, "reverseGeo": { "$ref": "#/components/schemas/reverseGeo" }, "speedMilesPerHour": { "$ref": "#/components/schemas/AssetLocationSpeed" }, "time": { "$ref": "#/components/schemas/time" } }, "required": [ "latitude", "longitude", "time" ], "type": "object" }, "EquipmentStatsListResponse": { "description": "A time-series of equipment stats and pagination information", "properties": { "data": { "description": "Time-series of stats for the specified units of equipment and stat types.", "items": { "$ref": "#/components/schemas/EquipmentStatsListResponse_data" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "EquipmentStatsListResponse_data": { "description": "A unit of equipment and its time-series of stats events.", "properties": { "engineRpm": { "description": "A time-series of engine RPM readings for the given unit of equipment.", "items": { "$ref": "#/components/schemas/EquipmentEngineRpm" }, "type": "array" }, "engineSeconds": { "description": "[DEPRECATED] Please use either `gatewayEngineSeconds`, `obdEngineSeconds`, or `gatewayJ1939EngineSeconds`.", "items": { "$ref": "#/components/schemas/EquipmentEngineSeconds" }, "type": "array" }, "engineStates": { "description": "[DEPRECATED] Please use either `gatewayEngineStates` or `obdEngineStates`.", "items": { "$ref": "#/components/schemas/EquipmentEngineState" }, "type": "array" }, "engineTotalIdleTimeMinutes": { "description": "A time-series of engine total idle time minutes. (Beta)", "items": { "$ref": "#/components/schemas/EquipmentEngineTotalIdleTimeMinutes" }, "type": "array" }, "fuelPercents": { "description": "A time-series of fuel percent level changes for the given unit of equipment.", "items": { "$ref": "#/components/schemas/EquipmentFuelPercent" }, "type": "array" }, "gatewayEngineSeconds": { "description": "A time-series of engine seconds readings for the given unit of equipment as an approximate based on readings from the AG26's aux/digio cable.", "items": { "$ref": "#/components/schemas/EquipmentGatewayEngineSeconds" }, "type": "array" }, "gatewayEngineStates": { "description": "A time-series of engine state changes (as read from the AG26's aux/digio cable) for the given unit of equipment.", "items": { "$ref": "#/components/schemas/EquipmentGatewayEngineState" }, "type": "array" }, "gatewayJ1939EngineSeconds": { "description": "A time-series of engine seconds readings for the given unit of equipment as an approximate based on readings from the AG26's CAT/J1939 cable.", "items": { "$ref": "#/components/schemas/EquipmentGatewayJ1939EngineSeconds" }, "type": "array" }, "gps": { "description": "A time-series of GPS locations.", "items": { "$ref": "#/components/schemas/EquipmentStatsGps" }, "type": "array" }, "gpsOdometerMeters": { "description": "A time-series of GPS odometer readings for the given unit of equipment.", "items": { "$ref": "#/components/schemas/EquipmentGpsOdometerMeters" }, "type": "array" }, "id": { "$ref": "#/components/schemas/EquipmentId" }, "name": { "$ref": "#/components/schemas/EquipmentName" }, "obdEngineSeconds": { "description": "A time-series of engine seconds readings for the given unit of equipment directly from on-board diagnostics.", "items": { "$ref": "#/components/schemas/EquipmentObdEngineSeconds" }, "type": "array" }, "obdEngineStates": { "description": "A time-series of engine state changes (as read from on-board diagnostics) for the given unit of equipment.", "items": { "$ref": "#/components/schemas/EquipmentObdEngineState" }, "type": "array" } }, "required": [ "id", "name" ], "type": "object" }, "EquipmentStatsResponse": { "description": "The most recent equipment stats and pagination information", "properties": { "data": { "description": "List of the most recent stats for the specified units of equipment and stat types.", "items": { "$ref": "#/components/schemas/EquipmentStatsResponse_data" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "EquipmentStatsResponse_data": { "description": "A unit of equipment and its most recent stat.", "properties": { "engineRpm": { "$ref": "#/components/schemas/EquipmentEngineRpm" }, "engineSeconds": { "$ref": "#/components/schemas/EquipmentEngineSeconds" }, "engineState": { "$ref": "#/components/schemas/EquipmentEngineState" }, "engineTotalIdleTimeMinutes": { "$ref": "#/components/schemas/EquipmentEngineTotalIdleTimeMinutes" }, "fuelPercent": { "$ref": "#/components/schemas/EquipmentFuelPercent" }, "gatewayEngineSeconds": { "$ref": "#/components/schemas/EquipmentGatewayEngineSeconds" }, "gatewayEngineState": { "$ref": "#/components/schemas/EquipmentGatewayEngineState" }, "gps": { "$ref": "#/components/schemas/EquipmentStatsGps" }, "gpsOdometerMeters": { "$ref": "#/components/schemas/EquipmentGpsOdometerMeters" }, "id": { "$ref": "#/components/schemas/EquipmentId" }, "name": { "$ref": "#/components/schemas/EquipmentName" }, "obdEngineSeconds": { "$ref": "#/components/schemas/EquipmentObdEngineSeconds" }, "obdEngineState": { "$ref": "#/components/schemas/EquipmentObdEngineState" } }, "required": [ "id", "name" ], "type": "object" }, "EquipmentTime": { "description": "UTC timestamp of the time the data point was generated by the equipment, in RFC3339 format.", "example": "2019-05-03T04:30:31Z", "type": "string" }, "EquipmentWithAttributesResponseObjectResponseBody": { "description": "The equipment object.", "properties": { "attributes": { "description": "List of attributes associated with the entity", "items": { "$ref": "#/components/schemas/GoaAttributeTinyResponseBody" }, "type": "array" }, "equipmentSerialNumber": { "description": "The serial number of the equipment.", "example": "8V8WD530FLN016251", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed.", "example": "494123", "type": "string" }, "installedGateway": { "$ref": "#/components/schemas/GoaGatewayTinyResponseResponseBody" }, "name": { "description": "The human-readable name of the Equipment. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Equipment-123", "type": "string" }, "notes": { "description": "These are generic notes about the Equipment. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are my equipment notes", "maxLength": 255, "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Equipment.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" } }, "type": "object" }, "Equipment_installedGateway": { "properties": { "model": { "description": "The model of the installed Samsara gateway.", "example": "Ag26", "type": "string" }, "serial": { "description": "The serial of the installed Samsara gateway.", "type": "string" } }, "type": "object" }, "ExtendedDriverTinyResponse": { "description": "A minified driver object.", "properties": { "externalIds": { "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "properties": { }, "type": "object" }, "id": { "description": "ID of the driver.", "example": "88668", "type": "string" }, "name": { "description": "Name of the driver.", "example": "Susan Bob", "type": "string" }, "username": { "description": "Username of the driver.", "example": "susanbob", "type": "string" } }, "type": "object" }, "FftSpectraDataPoint": { "description": "FFT spectrum data point of a data input.", "properties": { "fftSpectra": { "$ref": "#/components/schemas/FftSpectraDataPoint_fftSpectra" }, "time": { "$ref": "#/components/schemas/time" } }, "type": "object" }, "FftSpectraDataPoint_fftSpectra": { "description": "FFT spectrum data", "properties": { "frequencies": { "description": "Frequencies", "items": { "format": "double", "type": "number" }, "type": "array" }, "x": { "description": "X-axis data", "items": { "format": "double", "type": "number" }, "type": "array" }, "y": { "description": "Y-axis data", "items": { "format": "double", "type": "number" }, "type": "array" }, "z": { "description": "Z-axis data", "items": { "format": "double", "type": "number" }, "type": "array" } }, "type": "object" }, "FollowingDistanceDetectionAlertSettingsObjectResponseBody": { "description": "Enables AI detection of tailgating or unsafe following distances, surfaces events in Safety Inbox, and enables configurable alerts. By default, Following Distance will impact the drivers' safety score.", "properties": { "durationMs": { "description": "Duration of following distance at which to alert, measured in milliseconds.", "example": 15000, "format": "int64", "type": "integer" }, "hasInCabAudioAlertsEnabled": { "description": "Indicates whether in-cab audio alerts for following distance are turned on.", "example": true, "type": "boolean" }, "isEnabled": { "description": "Indicates whether AI event detection for following distance is turned on.", "example": true, "type": "boolean" }, "speedingThresholdMph": { "description": "Alert when speed is over this many miles per hour.", "example": 35, "format": "double", "type": "number" } }, "type": "object" }, "FormSubmissionPdfExportResponseObjectResponseBody": { "description": "Form Submission PDF export response object.", "properties": { "completedAtTime": { "description": "Time when the PDF export job was completed. Included if 'jobStatus' is 'done'. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "errorMessage": { "description": "An error message for failed PDF export jobs. Included if 'jobStatus' is 'failed'.", "example": "PDF export timed out.", "type": "string" }, "expiresAtTime": { "description": "Time when the PDF export job expires. After expiration, GET requests for this job will fail and clients must create a new one with another POST request. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "id": { "description": "ID of the form submission being exported.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "jobStatus": { "description": "Status of the PDF export job. Valid values: `unknown`, `pending`, `done`, `failed`", "enum": [ "unknown", "pending", "done", "failed" ], "example": "pending", "type": "string" }, "pdfId": { "description": "Unique ID for the PDF export that is created.", "example": "300af62b-5aea-43a9-b4cf-a59667e817ed", "type": "string" }, "pdfUrl": { "description": "URL to download the PDF file. Expires at time specified in 'pdfUrlExpiresAtTime'. Included if 'jobStatus' is 'done'.", "example": "https://samsara-pdf-exports.s3.us-west-2.amazonaws.com/123456", "type": "string" }, "pdfUrlExpiresAtTime": { "description": "Time when the PDF export's 'pdfUrl' expires. After expiration, clients can retrieve a fresh url with another GET request. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "requestedAtTime": { "description": "Time when the PDF export POST request was made. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "expiresAtTime", "id", "jobStatus", "pdfId", "requestedAtTime" ], "type": "object" }, "FormSubmissionRequestApprovalDetailsRequestBody": { "description": "The details of a form approval. Only valid for forms that require approvals.", "properties": { "comment": { "description": "Comment for the approval decision. Sometimes required when updating status to 'changesRequested'. Only valid when requesting changes or approving a form submission.", "example": "Approving this submission", "type": "string" } }, "type": "object" }, "FormSubmissionRequestAssetObjectRequestBody": { "description": "Asset object.", "properties": { "id": { "description": "Samsara ID of the asset.", "example": "281474982859091", "type": "string" } }, "required": [ "id" ], "type": "object" }, "FormSubmissionRequestAssetValueObjectRequestBody": { "description": "The value of an asset form input field. Only valid for asset form input fields.", "properties": { "asset": { "$ref": "#/components/schemas/FormSubmissionRequestAssetObjectRequestBody" } }, "required": [ "asset" ], "type": "object" }, "FormSubmissionRequestAssignedToRequestBody": { "description": "Form submission assignee update object", "properties": { "id": { "description": "ID of the form submission assignee.", "example": "938172", "type": "string" }, "type": { "description": "Type of the form submission assignee. Valid values: `driver`, `user`", "enum": [ "driver", "user" ], "example": "driver", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "FormSubmissionRequestCheckBoxesValueObjectRequestBody": { "description": "The value of a check boxes form input field. Only valid for check boxes form input fields.", "properties": { "valueIds": { "example": [ "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7", "2214a1fa-f0c6-408b-bf85-51dc3bc71ac7", "3214a1fa-f0c6-408b-bf85-51dc3bc71ac7" ], "items": { "example": "233374f1-297f-8711-5fc3-4f6b3731ad63", "format": "uuid", "type": "string" }, "type": "array" } }, "required": [ "valueIds" ], "type": "object" }, "FormSubmissionRequestDateTimeValueObjectRequestBody": { "description": "The value of a datetime form input field. Only valid for datetime form input fields.", "properties": { "value": { "description": "The value of the user generated date/time field response. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "value" ], "type": "object" }, "FormSubmissionRequestFieldInputObjectRequestBody": { "description": "Forms input field request body object.", "properties": { "assetValue": { "$ref": "#/components/schemas/FormSubmissionRequestAssetValueObjectRequestBody" }, "checkBoxesValue": { "$ref": "#/components/schemas/FormSubmissionRequestCheckBoxesValueObjectRequestBody" }, "dateTimeValue": { "$ref": "#/components/schemas/FormSubmissionRequestDateTimeValueObjectRequestBody" }, "id": { "description": "ID of the forms input field object.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" }, "multipleChoiceValue": { "$ref": "#/components/schemas/FormSubmissionRequestMultipleChoiceValueObjectRequestBody" }, "numberValue": { "$ref": "#/components/schemas/FormSubmissionRequestNumberValueObjectRequestBody" }, "personValue": { "$ref": "#/components/schemas/FormSubmissionRequestPersonValueObjectRequestBody" }, "tableValue": { "$ref": "#/components/schemas/FormSubmissionRequestTableValueObjectRequestBody" }, "textValue": { "$ref": "#/components/schemas/FormSubmissionRequestTextValueObjectRequestBody" }, "type": { "description": "Type of the field. Valid values: `number`, `text`, `multiple_choice`, `check_boxes`, `datetime`, `asset`, `person`, `table`", "enum": [ "number", "text", "multiple_choice", "check_boxes", "datetime", "asset", "person", "table" ], "example": "number", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "FormSubmissionRequestMultipleChoiceValueObjectRequestBody": { "description": "The value of a multiple choice form input field. Only valid for multiple choice form input fields.", "properties": { "valueId": { "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" } }, "required": [ "valueId" ], "type": "object" }, "FormSubmissionRequestNumberValueObjectRequestBody": { "description": "The value of a number form input field. Only valid for number form input fields.", "properties": { "value": { "example": 123.456, "format": "double", "type": "number" } }, "required": [ "value" ], "type": "object" }, "FormSubmissionRequestPersonObjectRequestBody": { "description": "Person object.", "properties": { "polymorphicUserId": { "description": "Samsara polymorphicUserID of the person.", "example": "user-12345", "type": "string" } }, "required": [ "polymorphicUserId" ], "type": "object" }, "FormSubmissionRequestPersonValueObjectRequestBody": { "description": "The value of an person form input field. Only valid for person form input fields.", "properties": { "person": { "$ref": "#/components/schemas/FormSubmissionRequestPersonObjectRequestBody" } }, "required": [ "person" ], "type": "object" }, "FormSubmissionRequestTableCellObjectRequestBody": { "description": "The value of a cell in a table row.", "properties": { "checkBoxesValue": { "$ref": "#/components/schemas/FormSubmissionRequestCheckBoxesValueObjectRequestBody" }, "dateTimeValue": { "$ref": "#/components/schemas/FormSubmissionRequestDateTimeValueObjectRequestBody" }, "id": { "description": "Unique identifier for the cell.", "example": "9fac4466-9d85-4768-9f1f-ff8f757f70c4", "format": "uuid", "type": "string" }, "multipleChoiceValue": { "$ref": "#/components/schemas/FormSubmissionRequestMultipleChoiceValueObjectRequestBody" }, "numberValue": { "$ref": "#/components/schemas/FormSubmissionRequestNumberValueObjectRequestBody" }, "personValue": { "$ref": "#/components/schemas/FormSubmissionRequestPersonValueObjectRequestBody" }, "textValue": { "$ref": "#/components/schemas/FormSubmissionRequestTextValueObjectRequestBody" }, "type": { "description": "Type of the cell field. Valid values: `number`, `text`, `multiple_choice`, `check_boxes`, `datetime`, `person`", "enum": [ "number", "text", "multiple_choice", "check_boxes", "datetime", "person" ], "example": "number", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "FormSubmissionRequestTableRowObjectRequestBody": { "description": "The value of a row in a table form input field.", "properties": { "cells": { "description": "List of cells in the row.", "items": { "$ref": "#/components/schemas/FormSubmissionRequestTableCellObjectRequestBody" }, "type": "array" }, "id": { "description": "Unique identifier for the row.", "example": "ee62df83-16e8-46ae-94d6-4933848f5e66", "format": "uuid", "type": "string" } }, "required": [ "cells", "id" ], "type": "object" }, "FormSubmissionRequestTableValueObjectRequestBody": { "description": "The value of a table form input field. Only valid for table form input fields.", "properties": { "rows": { "description": "List of rows in the table.", "items": { "$ref": "#/components/schemas/FormSubmissionRequestTableRowObjectRequestBody" }, "type": "array" } }, "required": [ "rows" ], "type": "object" }, "FormSubmissionRequestTextValueObjectRequestBody": { "description": "The value of a text form input field. Only valid for text form input fields.", "properties": { "value": { "example": "Exposed wires", "type": "string" } }, "required": [ "value" ], "type": "object" }, "FormSubmissionResponseObjectResponseBody": { "description": "Form Submission response object.", "properties": { "asset": { "$ref": "#/components/schemas/FormsAssetObjectResponseBody" }, "assignedAtTime": { "description": "Assignment time of the form submission. Sometimes returned if the submission was assigned to a user or driver. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "assignedTo": { "$ref": "#/components/schemas/FormsPolymorphicUserObjectResponseBody" }, "createdAtTime": { "description": "Creation time of the form submission. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "dueAtTime": { "description": "Time of when the submission is due. Sometimes returned, if the submission has a due date. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "fields": { "description": "List of field inputs in a form submission.", "items": { "$ref": "#/components/schemas/FormsFieldInputObjectResponseBody" }, "type": "array" }, "formTemplate": { "$ref": "#/components/schemas/FormTemplateReferenceObjectResponseBody" }, "id": { "description": "ID of the form submission.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "isRequired": { "description": "Indicates whether the worker is required to complete this form or not. Always returned.", "example": true, "type": "boolean" }, "location": { "$ref": "#/components/schemas/FormsLocationObjectResponseBody" }, "routeId": { "description": "ID of the route. Sometimes returned if the submission was assigned to a route stop.", "example": "123456789", "type": "string" }, "routeStopId": { "description": "ID of the route stop. Sometimes returned if the submission was assigned to a route stop.", "example": "987654321", "type": "string" }, "score": { "$ref": "#/components/schemas/FormsScoreObjectResponseBody" }, "status": { "description": "State for the Form Submission. Always returned. Valid values: `notStarted`, `completed`, `archived`, `inProgress`, `needsReview`, `changesRequested`, `approved`", "enum": [ "notStarted", "completed", "archived", "inProgress", "needsReview", "changesRequested", "approved" ], "example": "notStarted", "type": "string" }, "submittedAtTime": { "description": "Submission time of the form submission. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "submittedBy": { "$ref": "#/components/schemas/FormsPolymorphicUserObjectResponseBody" }, "title": { "description": "Title of the form submission. Sometimes returned if the submission has a title.", "example": "Form Submission Title", "type": "string" }, "updatedAtTime": { "description": "Update time of the form submission. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "createdAtTime", "fields", "formTemplate", "id", "isRequired", "status", "submittedAtTime", "submittedBy", "updatedAtTime" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/FormSubmissionPdfExportResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsPdfExportsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsResponseBody": { "properties": { "data": { "description": "List of form submissions.", "items": { "$ref": "#/components/schemas/FormSubmissionResponseObjectResponseBody" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamResponseBody": { "properties": { "data": { "description": "List of form submissions.", "items": { "$ref": "#/components/schemas/FormSubmissionResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsStreamUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsGetFormSubmissionsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionRequestBody": { "description": "Form submission fields to update.", "example": { "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac8", "status": "notStarted" }, "properties": { "approvalDetails": { "$ref": "#/components/schemas/FormSubmissionRequestApprovalDetailsRequestBody" }, "assignedTo": { "$ref": "#/components/schemas/FormSubmissionRequestAssignedToRequestBody" }, "dueAtTime": { "description": "Due date of the form submission. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "id": { "description": "ID of the form submission.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "isRequired": { "description": "Indicates whether the worker is required to complete this form or not at a specific route stop. Defaults to `true` if the form is assigned to a user or driver. When true, the worker cannot depart the route stop until this form submission is `submitted`.", "example": true, "type": "boolean" }, "routeStopId": { "description": "ID of the route stop the form submission is assigned to. Must be a unique Samsara ID.", "example": "4070621712", "type": "string" }, "status": { "description": "Status of the form submission. Valid values: `notStarted`, `archived`, `inProgress`, `changesRequested`, `approved`", "enum": [ "notStarted", "archived", "inProgress", "changesRequested", "approved" ], "example": "notStarted", "type": "string" }, "title": { "description": "Title of the form submission.", "example": "Job - J999", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/FormSubmissionResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPatchFormSubmissionUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionRequestBody": { "description": "Form submission fields to create.", "example": { "formTemplate": { "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "revisionId": "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7" }, "status": "notStarted" }, "properties": { "assignedTo": { "$ref": "#/components/schemas/FormSubmissionRequestAssignedToRequestBody" }, "dueAtTime": { "description": "Due date of the form submission. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "fields": { "description": "List of field inputs in a form submission.", "items": { "$ref": "#/components/schemas/FormSubmissionRequestFieldInputObjectRequestBody" }, "type": "array" }, "formTemplate": { "$ref": "#/components/schemas/FormTemplateReferenceObjectRequestBody" }, "isRequired": { "description": "Indicates whether the worker is required to complete this form or not at a specific route stop. Defaults to `true` if the form is assigned to a user or driver. When true, the worker cannot depart the route stop until this form submission is `submitted`.", "example": true, "type": "boolean" }, "routeStopId": { "description": "ID of the route stop the form submission is assigned to. Must be a unique Samsara ID.", "example": "4070621712", "type": "string" }, "status": { "description": "Status of the form submission. Valid values: `notStarted`", "enum": [ "notStarted" ], "example": "notStarted", "type": "string" }, "title": { "description": "Title of the form submission.", "example": "Job - J999", "maxLength": 255, "type": "string" } }, "required": [ "formTemplate", "status" ], "type": "object" }, "FormSubmissionsPostFormSubmissionResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/FormSubmissionResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "FormSubmissionsPostFormSubmissionServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/FormSubmissionPdfExportResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmissionsPostFormSubmissionsPdfExportsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormSubmittedResponseBody": { "description": "Details specific to Form Submitted.", "properties": { "form": { "$ref": "#/components/schemas/FormSubmissionResponseObjectResponseBody" } }, "required": [ "form" ], "type": "object" }, "FormTemplateReferenceObjectRequestBody": { "description": "Form template reference object.", "properties": { "id": { "description": "ID of the form template.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" }, "revisionId": { "description": "ID of the form template revision.", "example": "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" } }, "required": [ "id", "revisionId" ], "type": "object" }, "FormTemplateReferenceObjectResponseBody": { "description": "Form template reference object.", "properties": { "id": { "description": "ID of the form template.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" }, "revisionId": { "description": "ID of the form template revision.", "example": "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" } }, "required": [ "id", "revisionId" ], "type": "object" }, "FormTemplateResponseObjectResponseBody": { "description": "Form Template response object.", "properties": { "approvalConfig": { "$ref": "#/components/schemas/FormsApprovalConfigObjectResponseBody" }, "createdAtTime": { "description": "Creation time of the form template. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "createdBy": { "$ref": "#/components/schemas/FormsPolymorphicUserObjectResponseBody" }, "description": { "description": "Description of the form template.", "example": "This is a form template for job J999.", "type": "string" }, "fields": { "description": "List of fields in the form template.", "items": { "$ref": "#/components/schemas/FormsFieldDefinitionObjectResponseBody" }, "type": "array" }, "id": { "description": "Unique identifier of the form template.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" }, "revisionId": { "description": "Unique identifier of the form template revision.", "example": "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" }, "sections": { "description": "List of sections in the form template.", "items": { "$ref": "#/components/schemas/FormTemplateSectionObjectResponseBody" }, "type": "array" }, "title": { "description": "Title of the form template.", "example": "Job - J999", "type": "string" }, "updatedAtTime": { "description": "Update time of the form template. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "updatedBy": { "$ref": "#/components/schemas/FormsPolymorphicUserObjectResponseBody" } }, "required": [ "createdAtTime", "createdBy", "description", "fields", "id", "revisionId", "sections", "title", "updatedAtTime", "updatedBy" ], "type": "object" }, "FormTemplateSectionObjectResponseBody": { "description": "Form Template section object.", "properties": { "fieldIndexFirstInclusive": { "description": "The index of the first field from the fields array that is in this section. Index 0 represents the first field definition of the fields array.", "example": 0, "format": "int64", "type": "integer" }, "fieldIndexLastInclusive": { "description": "The index of the last field from the fields array that is in this section.", "example": 9, "format": "int64", "type": "integer" }, "label": { "description": "Label of the section.", "example": "Engine Hours", "type": "string" } }, "required": [ "fieldIndexFirstInclusive", "fieldIndexLastInclusive", "label" ], "type": "object" }, "FormTemplatesGetFormTemplatesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormTemplatesGetFormTemplatesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormTemplatesGetFormTemplatesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormTemplatesGetFormTemplatesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormTemplatesGetFormTemplatesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormTemplatesGetFormTemplatesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormTemplatesGetFormTemplatesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormTemplatesGetFormTemplatesResponseBody": { "properties": { "data": { "description": "List of form templates.", "items": { "$ref": "#/components/schemas/FormTemplateResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "FormTemplatesGetFormTemplatesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormTemplatesGetFormTemplatesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormTemplatesGetFormTemplatesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FormsApprovalConfigObjectResponseBody": { "description": "Form Template approval configuration object.", "properties": { "singleApprovalConfig": { "$ref": "#/components/schemas/FormsSingleApprovalConfigObjectResponseBody" }, "type": { "description": "Type of approval. Valid values: `singleApproval`", "enum": [ "singleApproval" ], "example": "singleApproval", "type": "string" } }, "required": [ "type" ], "type": "object" }, "FormsAssetObjectResponseBody": { "description": "Tracked or untracked (i.e. manually entered) asset object.", "properties": { "entryType": { "description": "The type of entry for the asset. Valid values: `tracked`, `untracked`", "enum": [ "tracked", "untracked" ], "example": "tracked", "type": "string" }, "id": { "description": "ID of a tracked asset. Included if 'entryType' is 'tracked'.", "example": "281474982859091", "type": "string" }, "name": { "description": "Name of an untracked (i.e. manually entered) asset.", "example": "trailer 123", "type": "string" } }, "required": [ "entryType" ], "type": "object" }, "FormsAssetValueObjectResponseBody": { "description": "The value of an asset form input field.", "properties": { "asset": { "$ref": "#/components/schemas/FormsAssetObjectResponseBody" } }, "required": [ "asset" ], "type": "object" }, "FormsCheckBoxesValueObjectResponseBody": { "description": "The value of a check boxes form input field.", "properties": { "value": { "description": "List of selected options.", "example": [ "Option A", "Option B" ], "items": { "description": "Option", "example": "Dolores ratione nesciunt voluptatem aut quia.", "type": "string" }, "type": "array" } }, "required": [ "value" ], "type": "object" }, "FormsDateTimeValueObjectResponseBody": { "description": "The value of a datetime form input field.", "properties": { "type": { "description": "The type of datetime format. Valid values: `datetime`, `date`, `time`", "enum": [ "datetime", "date", "time" ], "example": "datetime", "type": "string" }, "value": { "description": "UTC timestamp in RFC 3339 format.", "example": "2024-08-08T18:53:23Z", "format": "date-time", "type": "string" } }, "required": [ "type", "value" ], "type": "object" }, "FormsFieldDefinitionObjectResponseBody": { "description": "Forms field definition object.", "properties": { "allowManualEntry": { "description": "Indicates whether the field allows manual entry of a person. Only present for person fields.", "example": true, "type": "boolean" }, "allowedAssetTypes": { "description": "List of allowed asset types that can be selected for this field. Only present for asset fields.", "example": [ "Vehicle", "Trailer" ], "items": { "description": " Valid values: `Vehicle`, `Trailer`, `Equipment`, `UnpoweredAsset`", "enum": [ "Vehicle", "Trailer", "Equipment", "UnpoweredAsset" ], "example": "Vehicle", "type": "string" }, "type": "array" }, "allowedDateTimeValueType": { "description": "Type of date/time entry allowed for this question. Only present for datetime fields. Valid values: `datetime`, `date`, `time`", "enum": [ "datetime", "date", "time" ], "example": "datetime", "type": "string" }, "filterByCurrentDriverTags": { "description": "Indicates whether the person search filters by the current logged in worker's tags. Only present for person fields.", "example": true, "type": "boolean" }, "filterByRoleIds": { "description": "List of role IDs to filter org users by, representing which roles are selectable people for this field. Only present for person fields.", "example": [ "23d4d8d3-dc10-4e7a-a183-69968751f23e" ], "items": { "example": "Quo facere sint molestiae ipsum distinctio qui.", "type": "string" }, "type": "array" }, "id": { "description": "Identifier of the field.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" }, "includeDrivers": { "description": "Indicates whether the field includes drivers as selectable people. Only present for person fields.", "example": true, "type": "boolean" }, "includeUsers": { "description": "Indicates whether the field includes users as selectable people. Only present for person fields.", "example": true, "type": "boolean" }, "isRequired": { "description": "Indicates whether the form field is required to be filled out by the user.", "example": true, "type": "boolean" }, "label": { "description": "Label of the field.", "example": "Engine Hours", "type": "string" }, "legalText": { "description": "Legal text for the field. Only present for signature fields.", "example": "I consent to using electronic signatures in this transaction.", "type": "string" }, "numDecimalPlaces": { "description": "Number of decimal places allowed. Only present for number fields.", "example": 2, "format": "int64", "type": "integer" }, "options": { "description": "List of select options for checkboxes or multiple choice fields.", "items": { "$ref": "#/components/schemas/FormsSelectOptionObjectResponseBody" }, "type": "array" }, "questionWeight": { "description": "The maximum possible score weight for this field. For multiple choice fields, this number is the highest option score weight of the given options. For checkboxes fields, this number is the sum of the score weights for all scored options. Only present for multiple choice or checkboxes fields that have scoring.", "example": 5, "format": "int64", "type": "integer" }, "type": { "description": "Type of the field. Valid values: `number`, `text`, `multiple_choice`, `check_boxes`, `media`, `datetime`, `signature`, `asset`, `person`, `geofence`, `instruction`, `media_instruction`", "enum": [ "number", "text", "multiple_choice", "check_boxes", "media", "datetime", "signature", "asset", "person", "geofence", "instruction", "media_instruction" ], "example": "number", "type": "string" } }, "required": [ "id", "isRequired", "label", "type" ], "type": "object" }, "FormsFieldInputObjectResponseBody": { "description": "Forms input field object.", "properties": { "assetValue": { "$ref": "#/components/schemas/FormsAssetValueObjectResponseBody" }, "checkBoxesValue": { "$ref": "#/components/schemas/FormsCheckBoxesValueObjectResponseBody" }, "dateTimeValue": { "$ref": "#/components/schemas/FormsDateTimeValueObjectResponseBody" }, "id": { "description": "ID of the forms input field object.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" }, "issue": { "$ref": "#/components/schemas/FormsIssueCreatedByFieldObjectResponseBody" }, "label": { "description": "Forms input field label.", "example": "Engine Hours", "type": "string" }, "mediaList": { "description": "List of forms media record objects.", "items": { "$ref": "#/components/schemas/FormsMediaRecordObjectResponseBody" }, "type": "array" }, "mediaValue": { "$ref": "#/components/schemas/FormsMediaValueObjectResponseBody" }, "multipleChoiceValue": { "$ref": "#/components/schemas/FormsMultipleChoiceValueObjectResponseBody" }, "note": { "description": "A note attached to the field input.", "example": "Fire and oil can lead to an accident.", "type": "string" }, "numberValue": { "$ref": "#/components/schemas/FormsNumberValueObjectResponseBody" }, "personValue": { "$ref": "#/components/schemas/FormsPersonValueObjectResponseBody" }, "signatureValue": { "$ref": "#/components/schemas/FormsSignatureValueObjectResponseBody" }, "tableValue": { "$ref": "#/components/schemas/FormsTableValueObjectResponseBody" }, "textValue": { "$ref": "#/components/schemas/FormsTextValueObjectResponseBody" }, "type": { "description": "Type of the field. Valid values: `number, text, multiple_choice, check_boxes, datetime, signature, media, asset, table`", "enum": [ "number, text, multiple_choice, check_boxes, datetime, signature, media, asset, table" ], "example": "number", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "FormsIssueCreatedByFieldObjectResponseBody": { "description": "Issue created from this form input field input object.", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the issue created from this form input field input object.", "example": "12345", "type": "string" } }, "required": [ "id" ], "type": "object" }, "FormsLocationObjectResponseBody": { "description": "Form template location object.", "properties": { "latitude": { "description": "Latitude of a location.", "example": 12333122.3, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of a location.", "example": 1233331.4, "format": "double", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "FormsMediaRecordObjectResponseBody": { "description": "Forms media record object.", "properties": { "id": { "description": "ID of the media record.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" }, "processingStatus": { "description": "Status of the media record. Valid values: `unknown`, `processing`, `finished`", "enum": [ "unknown", "processing", "finished" ], "example": "processing", "type": "string" }, "url": { "description": "URL containing a link to associated media content. Included if 'processingStatus' is 'finished'.", "example": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456", "format": "uri", "type": "string" }, "urlExpiresAt": { "description": "Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "id", "processingStatus" ], "type": "object" }, "FormsMediaValueObjectResponseBody": { "description": "The value of a media form input field.", "properties": { "mediaList": { "description": "List of forms media record objects.", "items": { "$ref": "#/components/schemas/FormsMediaRecordObjectResponseBody" }, "type": "array" } }, "required": [ "mediaList" ], "type": "object" }, "FormsMultipleChoiceValueObjectResponseBody": { "description": "The value of a multiple choice form input field.", "properties": { "value": { "description": "Selected choice.", "example": "Yes", "type": "string" } }, "required": [ "value" ], "type": "object" }, "FormsNumberValueObjectResponseBody": { "description": "The value of a number form input field.", "properties": { "value": { "description": "Number value.", "example": 123.456, "format": "double", "type": "number" } }, "required": [ "value" ], "type": "object" }, "FormsPersonObjectResponseBody": { "description": "Tracked or untracked (i.e. manually entered) person object.", "properties": { "entryType": { "description": "The type of entry for the person. Valid values: `tracked`, `untracked`", "enum": [ "tracked", "untracked" ], "example": "tracked", "type": "string" }, "name": { "description": "Name of an untracked (i.e. manually entered) person.", "example": "Jake", "type": "string" }, "polymorphicUserId": { "$ref": "#/components/schemas/FormsPolymorphicUserObjectResponseBody" } }, "required": [ "entryType" ], "type": "object" }, "FormsPersonValueObjectResponseBody": { "description": "The value of a person form input field.", "properties": { "person": { "$ref": "#/components/schemas/FormsPersonObjectResponseBody" } }, "required": [ "person" ], "type": "object" }, "FormsPolymorphicUserObjectResponseBody": { "description": "User or driver object.", "properties": { "id": { "description": "ID of the polymorphic user.", "example": "938172", "type": "string" }, "type": { "description": "The type of the polymorphic user. Valid values: `driver`, `user`", "enum": [ "driver", "user" ], "example": "driver", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "FormsScoreObjectResponseBody": { "description": "Forms score object.", "properties": { "maxPoints": { "description": "Total possible points of the form submission.", "example": 80, "format": "double", "type": "number" }, "scorePercent": { "description": "Percentage score of the form submission, calculated as scorePoints / maxPoints.", "example": 75, "format": "double", "type": "number" }, "scorePoints": { "description": "Score, in points, of the form submission.", "example": 60, "format": "double", "type": "number" } }, "required": [ "maxPoints", "scorePercent", "scorePoints" ], "type": "object" }, "FormsSelectOptionObjectResponseBody": { "description": "Multiple choice or checkbox value option object.", "properties": { "id": { "description": "Identifier of the option.", "example": "e879028d-bce5-0238-ffec-11cd9236bcda", "type": "string" }, "ignoreQuestionFromScoreIfSelected": { "description": "Indicates whether the question should be ignored from the total score if this option is selected. Returns true if a score weight was not given to this option. Only present when the select form field has scoring.", "example": false, "type": "boolean" }, "label": { "description": "Label of the option.", "example": "Yes", "type": "string" }, "optionScoreWeight": { "description": "Score weight of the option, indicates number of score points received if this option is selected. Only present if the select form field has scoring.", "example": 5, "format": "int64", "type": "integer" } }, "required": [ "id", "label" ], "type": "object" }, "FormsSignatureValueObjectResponseBody": { "description": "The value of a signature form input field.", "properties": { "media": { "$ref": "#/components/schemas/FormsMediaRecordObjectResponseBody" } }, "required": [ "media" ], "type": "object" }, "FormsSingleApprovalConfigObjectResponseBody": { "description": "Single approval configuration object.", "properties": { "allowManualApproverSelection": { "description": "Indicates whether approver can be manually selected. True by default.", "example": true, "type": "boolean" }, "requirements": { "$ref": "#/components/schemas/SingleApprovalRequirementsObjectResponseBody" } }, "required": [ "allowManualApproverSelection", "requirements" ], "type": "object" }, "FormsTableCellObjectResponseBody": { "description": "Defines a cell in a table row.", "properties": { "checkBoxesValue": { "$ref": "#/components/schemas/FormsCheckBoxesValueObjectResponseBody" }, "dateTimeValue": { "$ref": "#/components/schemas/FormsDateTimeValueObjectResponseBody" }, "id": { "description": "Unique identifier for the cell.", "format": "uuid", "type": "string" }, "mediaValue": { "$ref": "#/components/schemas/FormsMediaValueObjectResponseBody" }, "multipleChoiceValue": { "$ref": "#/components/schemas/FormsMultipleChoiceValueObjectResponseBody" }, "numberValue": { "$ref": "#/components/schemas/FormsNumberValueObjectResponseBody" }, "personValue": { "$ref": "#/components/schemas/FormsPersonValueObjectResponseBody" }, "signatureValue": { "$ref": "#/components/schemas/FormsSignatureValueObjectResponseBody" }, "textValue": { "$ref": "#/components/schemas/FormsTextValueObjectResponseBody" }, "type": { "description": "Type of the cell field. Valid values: `number, text, multiple_choice, check_boxes, datetime, signature, media, person`", "enum": [ "number, text, multiple_choice, check_boxes, datetime, signature, media, person" ], "example": "number", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "FormsTableColumnObjectResponseBody": { "description": "Defines a column in a table form input field.", "properties": { "id": { "description": "Unique identifier for the column.", "format": "uuid", "type": "string" }, "label": { "description": "Label of the column.", "example": "Store Number", "type": "string" }, "type": { "description": "Type of the column field. Valid values: `text, number, datetime, check_boxes, multiple_choice, signature, media, person`", "enum": [ "text, number, datetime, check_boxes, multiple_choice, signature, media, person" ], "example": "number", "type": "string" } }, "required": [ "id", "label", "type" ], "type": "object" }, "FormsTableRowObjectResponseBody": { "description": "Defines a row in a table form input field.", "properties": { "cells": { "description": "List of cells in the row.", "items": { "$ref": "#/components/schemas/FormsTableCellObjectResponseBody" }, "type": "array" }, "id": { "description": "Unique identifier for the row.", "format": "uuid", "type": "string" } }, "required": [ "cells", "id" ], "type": "object" }, "FormsTableValueObjectResponseBody": { "description": "The value of a table form input field.", "properties": { "columns": { "description": "List of table columns.", "items": { "$ref": "#/components/schemas/FormsTableColumnObjectResponseBody" }, "type": "array" }, "rows": { "description": "List of table rows.", "items": { "$ref": "#/components/schemas/FormsTableRowObjectResponseBody" }, "type": "array" } }, "required": [ "columns", "rows" ], "type": "object" }, "FormsTextValueObjectResponseBody": { "description": "The value of a text form input field.", "properties": { "value": { "description": "Text value.", "example": "Exposed wires", "type": "string" } }, "required": [ "value" ], "type": "object" }, "ForwardCollisionDetectionAlertSettingsObjectResponseBody": { "description": "Enables AI detection of near forward collisions, surfaces events in Safety Inbox, and enables configurable alerts. While the feature is in beta, it is only enabled during daytime driving hours. In-cab alerts are recommended for testing use only.", "properties": { "hasInCabAudioAlertsEnabled": { "description": "Indicates whether in-cab audio alerts for forward collision are turned on.", "example": true, "type": "boolean" }, "isEnabled": { "description": "Indicates whether AI event detection for forward collision is turned on.", "example": true, "type": "boolean" }, "sensitivity": { "description": "Ranges from near forward collision (results in fewer events) to far forward collision (results in more events). Valid values: `near`, `medium`, `far`", "enum": [ "near", "medium", "far" ], "example": "near", "type": "string" } }, "type": "object" }, "FuelConsumedMl": { "description": "Fuel consumption in milliliters.", "type": "number" }, "FuelEnergyCostResponseResponseBody": { "description": "Estimated cost of fuel and energy over the given time range.", "properties": { "amount": { "description": "Amount of the currency.", "example": 94.01, "format": "double", "type": "number" }, "currencyCode": { "description": "Type of the currency.", "example": "USD", "type": "string" } }, "required": [ "amount", "currencyCode" ], "type": "object" }, "FuelEnergyDriverReportDataObjectResponseBody": { "description": "Dictionary containing summarized driver report data.", "properties": { "driverReports": { "description": "List of summarized driver reports.", "items": { "$ref": "#/components/schemas/FuelEnergyDriverReportObjectResponseBody" }, "type": "array" } }, "required": [ "driverReports" ], "type": "object" }, "FuelEnergyDriverReportObjectResponseBody": { "description": "A summary of this driver's fuel and energy data.", "properties": { "distanceTraveledMeters": { "description": "Meters traveled over the given time range.", "example": 1384000, "format": "double", "type": "number" }, "driver": { "$ref": "#/components/schemas/GoaDriverTinyResponseResponseBody" }, "efficiencyMpge": { "description": "Efficiency in MPG or MPGE over the given time range. For fuel vehicles this will be provided in MPG, for hybrid and electric vehicles this will be provided in MPGE. MPG/MPGE values are provided based on US gallons.", "example": 21.4, "format": "double", "type": "number" }, "energyUsedKwh": { "description": "Kilowatt-hours of energy used over the given time range. Only provided for hybrid and electric vehicles.", "example": 73.2, "format": "double", "type": "number" }, "engineIdleTimeDurationMs": { "description": "Milliseconds of engine idle time over the given time range. Only provided for fuel and hybrid vehicles.", "example": 4320000, "format": "int64", "type": "integer" }, "engineRunTimeDurationMs": { "description": "Milliseconds of engine run time over the given time range. Only provided for fuel and hybrid vehicles.", "example": 576000, "format": "int64", "type": "integer" }, "estCarbonEmissionsKg": { "description": "Estimated kilograms of carbon emissions over the given time range. Only provided for fuel and hybrid vehicles.", "example": 22.7, "format": "double", "type": "number" }, "estFuelEnergyCost": { "$ref": "#/components/schemas/FuelEnergyCostResponseResponseBody" }, "fuelConsumedMl": { "description": "Milliliters of fuel consumed over the given time range. Only provided for fuel and hybrid vehicles.", "example": 162773, "format": "double", "type": "number" } }, "required": [ "distanceTraveledMeters", "driver", "efficiencyMpge", "estFuelEnergyCost" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/FuelEnergyDriverReportDataObjectResponseBody" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyDriverReportsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/FuelEnergyVehicleReportDataObjectResponseBody" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyGetFuelEnergyVehicleReportsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelEnergyVehicleObjectResponseBody": { "description": "A minified vehicle object.", "properties": { "energyType": { "description": "Type of energy used by the vehicle Valid values: `fuel`, `hybrid`, `electric`", "enum": [ "fuel", "hybrid", "electric" ], "example": "fuel", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the vehicle", "example": "494123", "type": "string" }, "name": { "description": "Name of the vehicle", "example": "Fleet Truck #1", "type": "string" } }, "required": [ "energyType" ], "type": "object" }, "FuelEnergyVehicleReportDataObjectResponseBody": { "description": "Dictionary containing summarized vehicle report data.", "properties": { "vehicleReports": { "description": "List of summarized vehicle reports.", "items": { "$ref": "#/components/schemas/FuelEnergyVehicleReportObjectResponseBody" }, "type": "array" } }, "required": [ "vehicleReports" ], "type": "object" }, "FuelEnergyVehicleReportObjectResponseBody": { "description": "A summary of this vehicle's fuel and energy data.", "properties": { "distanceTraveledMeters": { "description": "Meters traveled over the given time range.", "example": 1384000, "format": "double", "type": "number" }, "efficiencyMpge": { "description": "Efficiency in MPG or MPGE over the given time range. For fuel vehicles this will be provided in MPG, for hybrid and electric vehicles this will be provided in MPGE. MPG/MPGE values are provided based on US gallons.", "example": 21.4, "format": "double", "type": "number" }, "energyUsedKwh": { "description": "Kilowatt-hours of energy used over the given time range. Only provided for hybrid and electric vehicles.", "example": 73.2, "format": "double", "type": "number" }, "engineIdleTimeDurationMs": { "description": "Milliseconds of engine idle time over the given time range. Only provided for fuel and hybrid vehicles.", "example": 4320000, "format": "int64", "type": "integer" }, "engineRunTimeDurationMs": { "description": "Milliseconds of engine run time over the given time range. Only provided for fuel and hybrid vehicles.", "example": 576000, "format": "int64", "type": "integer" }, "estCarbonEmissionsKg": { "description": "Estimated kilograms of carbon emissions over the given time range. Only provided for fuel and hybrid vehicles.", "example": 22.7, "format": "double", "type": "number" }, "estFuelEnergyCost": { "$ref": "#/components/schemas/FuelEnergyCostResponseResponseBody" }, "fuelConsumedMl": { "description": "Milliliters of fuel consumed over the given time range. Only provided for fuel and hybrid vehicles.", "example": 162773, "format": "double", "type": "number" }, "vehicle": { "$ref": "#/components/schemas/FuelEnergyVehicleObjectResponseBody" } }, "required": [ "distanceTraveledMeters", "efficiencyMpge", "estFuelEnergyCost", "vehicle" ], "type": "object" }, "FuelLevelPercentageResponseBody": { "description": "Details specific to Fuel Level Percentage.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "FuelLevelTriggerDetailsObjectRequestBody": { "description": "Details specific to Fuel Level Percentage", "properties": { "fuelLevelPercent": { "description": "The fuel level percentage threshold value.", "example": 20, "format": "int64", "type": "integer" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `LESS`", "enum": [ "LESS" ], "example": "LESS", "type": "string" } }, "required": [ "fuelLevelPercent", "minDurationMilliseconds", "operation" ], "type": "object" }, "FuelLevelTriggerDetailsObjectResponseBody": { "description": "Details specific to Fuel Level Percentage", "properties": { "fuelLevelPercent": { "description": "The fuel level percentage threshold value.", "example": 20, "format": "int64", "type": "integer" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `LESS`", "enum": [ "LESS" ], "example": "LESS", "type": "string" } }, "required": [ "fuelLevelPercent", "minDurationMilliseconds", "operation" ], "type": "object" }, "FuelPurchasePostFuelPurchaseBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelPurchasePostFuelPurchaseBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelPurchasePostFuelPurchaseGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelPurchasePostFuelPurchaseInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelPurchasePostFuelPurchaseMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelPurchasePostFuelPurchaseNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelPurchasePostFuelPurchaseNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelPurchasePostFuelPurchaseRequestBody": { "description": "Request payload for creating a new fuel purchase transaction.", "properties": { "fuelQuantityLiters": { "description": "The amount of fuel purchased in liters.", "example": "676.8", "type": "string" }, "iftaFuelType": { "description": "The type of fuel purchased supported by IFTA. Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`", "enum": [ "Unspecified", "A55", "Biodiesel", "CompressedNaturalGas", "Diesel", "E85", "Electricity", "Ethanol", "Gasohol", "Gasoline", "Hydrogen", "LiquifiedNaturalGas", "M85", "Methanol", "Propane", "Other" ], "example": "Biodiesel", "type": "string" }, "transactionLocation": { "description": "The full street address for the location of the fuel transaction, as it might be recognized by Google Maps. Ideal entries should be in accordance with the format used by the national postal service of the country concerned (example: 1 De Haro St, San Francisco, CA 94107, United States). Alternatively, exact latitude/longitude can be provided (example: 40.748441, -73.985664).", "example": "350 Rhode Island St, San Francisco, CA 94103", "type": "string" }, "transactionPrice": { "$ref": "#/components/schemas/PostFuelPurchaseRequestBodyPriceRequestBody" }, "transactionReference": { "description": "The fuel transaction reference. This is the transaction identifier. For instance, this can be the Serial Number on the invoice.", "example": "5454534", "maxLength": 32, "minLength": 1, "pattern": "^[a-zA-Z0-9\\-]+$", "type": "string" }, "transactionTime": { "description": "The time of the fuel transaction in RFC 3339 format. Timezone must be specified. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.", "example": "2022-07-13T14:20:50.52-07:00", "type": "string" }, "vehicleId": { "description": "Samsara ID of the vehicle that purchased the fuel.", "example": "281474900488527", "type": "string" } }, "required": [ "fuelQuantityLiters", "transactionLocation", "transactionPrice", "transactionReference", "transactionTime" ], "type": "object" }, "FuelPurchasePostFuelPurchaseResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PostFuelPurchaseResponseBodyResponseBody" } }, "required": [ "data" ], "type": "object" }, "FuelPurchasePostFuelPurchaseServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelPurchasePostFuelPurchaseTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelPurchasePostFuelPurchaseUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "FuelRemainingResponseBody": { "description": "Fuel remaining in equipment.", "properties": { "Percent": { "description": "Percent of fuel remaining in tank.", "example": 12, "format": "double", "type": "number" }, "datetime": { "description": "Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "GatewayAssetResponseObjectResponseBody": { "description": "An object containing information about the asset the gateway is installed on", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unique Samsara ID of the asset where the gateway is installed. This is automatically generated when the asset is created and cannot be changed. Use this ID on PATCH vehicle, equipment, or trailer endpoints to update the asset", "example": "8393848111", "type": "string" } }, "type": "object" }, "GatewayDetailsResponseResponseBody": { "description": "Gateway-specific health metadata.", "properties": { "cellConnectivity": { "$ref": "#/components/schemas/CellConnectivityResponseResponseBody" }, "gatewayBatteryState": { "description": "The gateway's battery state. Valid values: `low`, `ok`, `unknown`", "enum": [ "low", "ok", "unknown" ], "example": "low", "type": "string" }, "lastCheckInTime": { "description": "The timestamp of the gateway's last check-in, in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "vehicleBatteryVolts": { "description": "The battery voltage of the vehicle that gateway is connected to, in volts.", "example": 12.5, "format": "double", "type": "number" } }, "type": "object" }, "GatewayDisconnectedDetailsObjectRequestBody": { "description": "Details specific to Gateway Disconnected", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting. Can only be either 900000 (15 minutes) or 3600000 (60 min).", "example": 3600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "GatewayDisconnectedDetailsObjectResponseBody": { "description": "Details specific to Gateway Disconnected", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting. Can only be either 900000 (15 minutes) or 3600000 (60 min).", "example": 3600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "GatewayDisconnectedResponseBody": { "description": "Details specific to Gateway Disconnected.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "GatewayResponseObjectResponseBody": { "properties": { "accessoryDevices": { "description": "Accessory devices on gateway", "items": { "$ref": "#/components/schemas/AccessoryResponseObjectResponseBody" }, "type": "array" }, "asset": { "$ref": "#/components/schemas/GatewayAssetResponseObjectResponseBody" }, "connectionStatus": { "$ref": "#/components/schemas/ConnectionStatusResponseObjectResponseBody" }, "dataUsageLast30Days": { "$ref": "#/components/schemas/DataUsageResponseObjectResponseBody" }, "model": { "description": "The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `SG1B`, `SG1G`, `SG1G32`, `SG1x`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG34M`, `VG54ATT`, `VG54EU`, `VG54FN`, `VG54NA`, `VG54NAE`, `VG54NAH`, `VG55EU`, `VG55FN`, `VG55NA`", "enum": [ "AG15", "AG24", "AG24EU", "AG26", "AG26EU", "AG41", "AG41EU", "AG45", "AG45EU", "AG46", "AG46EU", "AG46P", "AG46PEU", "AG51", "AG51EU", "AG52", "AG52EU", "AG53", "AG53EU", "IG15", "IG21", "IG41", "IG61", "SG1", "SG1B", "SG1G", "SG1G32", "SG1x", "VG32", "VG33", "VG34", "VG34EU", "VG34FN", "VG34M", "VG54ATT", "VG54EU", "VG54FN", "VG54NA", "VG54NAE", "VG54NAH", "VG55EU", "VG55FN", "VG55NA" ], "example": "VG34", "type": "string" }, "serial": { "description": "The serial number of the gateway installed on the asset.", "example": "GFRV-43N-VGX", "type": "string" } }, "required": [ "model", "serial" ], "type": "object" }, "GatewayUnpluggedTriggerDetailsObjectRequestBody": { "description": "Details specific to Gateway Unplugged", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "GatewayUnpluggedTriggerDetailsObjectResponseBody": { "description": "Details specific to Gateway Unplugged", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "GatewayWithVehicleTinyResponseResponseBody": { "properties": { "model": { "description": "The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `SG1B`, `SG1G`, `SG1G32`, `SG1x`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG34M`, `VG54ATT`, `VG54EU`, `VG54FN`, `VG54NA`, `VG54NAE`, `VG54NAH`, `VG55EU`, `VG55FN`, `VG55NA`", "enum": [ "AG15", "AG24", "AG24EU", "AG26", "AG26EU", "AG41", "AG41EU", "AG45", "AG45EU", "AG46", "AG46EU", "AG46P", "AG46PEU", "AG51", "AG51EU", "AG52", "AG52EU", "AG53", "AG53EU", "IG15", "IG21", "IG41", "IG61", "SG1", "SG1B", "SG1G", "SG1G32", "SG1x", "VG32", "VG33", "VG34", "VG34EU", "VG34FN", "VG34M", "VG54ATT", "VG54EU", "VG54FN", "VG54NA", "VG54NAE", "VG54NAH", "VG55EU", "VG55FN", "VG55NA" ], "example": "VG34", "type": "string" }, "serial": { "description": "The serial number of the gateway installed on the asset.", "example": "GFRV-43N-VGX", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/GoaVehicleTinyResponseResponseBody" } }, "required": [ "model", "serial" ], "type": "object" }, "GatewaysDeleteGatewayBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysDeleteGatewayBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysDeleteGatewayGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysDeleteGatewayInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysDeleteGatewayMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysDeleteGatewayNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysDeleteGatewayNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysDeleteGatewayServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysDeleteGatewayTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysDeleteGatewayUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysResponseBody": { "properties": { "data": { "description": "Activated gateways", "items": { "$ref": "#/components/schemas/GatewayResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "GatewaysGetGatewaysServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysGetGatewaysUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayRequestBody": { "properties": { "serial": { "description": "Gateway serial number", "example": "GFRV-43N-VGX", "pattern": "^[a-zA-Z0-9]{4}-[a-zA-Z0-9]{3}-[a-zA-Z0-9]{3}|DC_([a-zA-Z0-9]){10}|SC_([a-zA-Z0-9]){10}$", "type": "string" } }, "required": [ "serial" ], "type": "object" }, "GatewaysPostGatewayResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/GatewayResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "GatewaysPostGatewayServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GatewaysPostGatewayUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "GeofenceEntryTriggerDetailsObjectRequestBody": { "description": "Details specific to Geofence Entry", "properties": { "location": { "$ref": "#/components/schemas/LocationObjectRequestBody" } }, "required": [ "location" ], "type": "object" }, "GeofenceEntryTriggerDetailsObjectResponseBody": { "description": "Details specific to Geofence Entry", "properties": { "location": { "$ref": "#/components/schemas/LocationObjectResponseBody" } }, "required": [ "location" ], "type": "object" }, "GeofenceExitTriggerDetailsObjectRequestBody": { "description": "Details specific to Geofence Exit", "properties": { "location": { "$ref": "#/components/schemas/LocationObjectRequestBody" } }, "required": [ "location" ], "type": "object" }, "GeofenceExitTriggerDetailsObjectResponseBody": { "description": "Details specific to Geofence Exit", "properties": { "location": { "$ref": "#/components/schemas/LocationObjectResponseBody" } }, "required": [ "location" ], "type": "object" }, "GeofenceResponseResponseBody": { "description": "Closest geofence based on 1000 meter radial search.", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "Unique ID of the geofence object.", "example": "12345", "type": "string" } }, "type": "object" }, "GetAttributesByEntityTypeResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/Attribute" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "GetCustomReportRunDataObjectResponseBody": { "properties": { "columns": { "description": "An array of objects containing data about column definitions", "items": { "$ref": "#/components/schemas/CustomReportColumnsObjectResponseBody" }, "type": "array" }, "rows": { "description": "An array of arrays that represents each row in a custom report. The first index represents which row the data is for and the second index represents which column the data is for. For example, rows[1][3] accesses the second row's fourth column data. ", "example": [ [ "Recusandae vitae molestiae incidunt aut voluptatem repudiandae.", "Error ad at consequatur." ], [ "Quod cumque eos omnis maiores quisquam laboriosam.", "Corrupti in dolor ad perspiciatis.", "Debitis sunt." ], [ "Sed et voluptate.", "Omnis ut minima nesciunt ut ea magnam.", "Dicta natus.", "Eligendi est consectetur." ] ], "items": { "description": "An array of arrays that represents a custom report. The first index represents which row the data is for and the second index represents which column the data is for. For example, rows[1][3] accesses the second row's fourth column data. See our [custom reports KB article](https://kb.samsara.com/hc/en-us/articles/360052711232-Manage-Custom-Reports) for more info on all available columns. Always returned.", "example": [ "Natus ut ut et.", "Nobis ut ratione fugiat non voluptatem incidunt.", "Autem corporis quae velit sit iure.", "Aut quis repudiandae illum dicta." ], "items": { "example": "Neque sunt recusandae ducimus.", "type": "object" }, "type": "array" }, "type": "array" } }, "required": [ "rows" ], "type": "object" }, "GetCustomReportRunObjectResponseBody": { "description": "The full custom report run object.", "properties": { "attributeValueIds": { "description": "The optional array of attribute value ids to filter the custom report run data by.", "example": [ "19abdecf-54f0-41de-991c-ee1e031134d1", "ab83dfce-54f0-41de-991c-ee1e031134d2" ], "items": { "example": "Et nemo recusandae maiores eum et.", "type": "string" }, "type": "array" }, "createdAtTime": { "description": "Time of when the custom report run was created in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "customReportId": { "description": "Unique ID for the custom report that it belongs to.", "example": "4f71fd67-54f0-41de-991c-ee1e031134d1", "type": "string" }, "endTime": { "description": "The end time of the custom report run in RFC 3339 format.", "example": "2019-06-13T21:08:25Z", "format": "date-time", "type": "string" }, "id": { "description": "Unique ID for the custom report run object.", "example": "4f71fd67-54f0-41de-991c-ee1e031134d1", "type": "string" }, "percentComplete": { "description": "The percentage completed of this custom report run. Valid values from 0-100, inclusive.", "example": 2.2089280586383493e+18, "format": "int64", "type": "integer" }, "startTime": { "description": "The start time of the custom report run in RFC 3339 format.", "example": "2019-06-13T21:08:25Z", "format": "date-time", "type": "string" }, "status": { "description": "The status of the custom report run. Valid values: `completed`, `pending`, `failed`, `cancelled`", "enum": [ "completed", "pending", "failed", "cancelled" ], "example": "completed", "type": "string" }, "tagIds": { "description": "The optional array of tag ids to filter the custom report run by.", "example": [ "4f71fd67-54f0-41de-991c-ee1e031134d1", "a0befd37-54f0-41de-991c-ee1e031134d2" ], "items": { "example": "Eius ex numquam commodi dolorum voluptatem iure.", "type": "string" }, "type": "array" }, "updatedAtTime": { "description": "Time of when the custom report run was last updated in RFC 3339 format.", "example": "2019-06-13T21:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "createdAtTime", "customReportId", "endTime", "id", "percentComplete", "startTime", "status", "updatedAtTime" ], "type": "object" }, "GetDriverTrailerAssignmentsResponseBodyResponseBody": { "description": "Object with driver assignment information and associated driver and trailer information.", "properties": { "createdAtTime": { "description": "Time when the driver trailer assignment was created, in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "driver": { "$ref": "#/components/schemas/DriverWithExternalIdObjectResponseBody" }, "endTime": { "description": "Time when the driver trailer assignment will end, in RFC 3339 format.", "example": "2019-06-13T20:10:25Z", "type": "string" }, "id": { "description": "Samsara ID of the driver trailer assignment.", "example": "08b3aeada5f4ab3010c0b4efa28d2d1890dbf8d48d2d6", "type": "string" }, "startTime": { "description": "Time when the driver trailer assignment starts, in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "trailer": { "$ref": "#/components/schemas/TrailerObjectResponseBody" }, "updatedAtTime": { "description": "Time when the driver trailer assignment was last updated, in RFC 3339 format.", "example": "2019-06-13T19:10:25Z", "type": "string" } }, "required": [ "driver", "id", "startTime", "trailer" ], "type": "object" }, "GetMediaRetrievalObjectResponseBody": { "properties": { "media": { "description": "List of media retrieval objects.", "items": { "$ref": "#/components/schemas/MediaObjectResponseBody" }, "type": "array" } }, "required": [ "media" ], "type": "object" }, "GetResponseWorkflowConfigurationObjectResponseBody": { "description": "The configuration of a alert.", "properties": { "actions": { "description": "An array of actions.", "items": { "$ref": "#/components/schemas/ActionObjectResponseBody" }, "type": "array" }, "createdAtTime": { "description": "The time the configuration was created in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unqiue Samsara id of the alert configuration.", "example": "e1c5dffc-c7b7-47b0-a778-6a65de638abf", "type": "string" }, "isEnabled": { "default": true, "description": "Whether the alert is enabled or not.", "example": true, "type": "boolean" }, "lastModifiedAtTime": { "description": "The time the configuration was last modified in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "name": { "description": "The custom name of the configuration.", "example": "My Harsh Event Alert", "type": "string" }, "operationalSettings": { "$ref": "#/components/schemas/OperationalSettingsObjectResponseBody" }, "scope": { "$ref": "#/components/schemas/ScopeObjectResponseBody" }, "triggers": { "description": "An array of triggers.", "items": { "$ref": "#/components/schemas/WorkflowTriggerObjectResponseBody" }, "type": "array" } }, "required": [ "actions", "createdAtTime", "id", "isEnabled", "lastModifiedAtTime", "name", "scope", "triggers" ], "type": "object" }, "GetWorkflowIncidentResponseObjectResponseBody": { "properties": { "conditions": { "description": "An array of conditions associated with the incident.", "items": { "$ref": "#/components/schemas/WorkflowIncidentConditionObjectResponseBody" }, "type": "array" }, "configurationId": { "description": "Unique ID of the alert configuration.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "happenedAtTime": { "description": "Time and date that the alert incident occurred in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "incidentUrl": { "description": "Url of alert incident in the cloud dashboard.", "example": "https://cloud.samsara.com/o/1/fleet/workflows/123", "type": "string" }, "isResolved": { "description": "Indicates whether the incident is resolved or not.", "example": true, "type": "boolean" }, "resolvedAtTime": { "description": "Time and date that the alert incident was resolved in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "updatedAtTime": { "description": "Time and date that the alert incident updated in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "required": [ "conditions", "configurationId", "happenedAtTime", "incidentUrl", "isResolved", "updatedAtTime" ], "type": "object" }, "GoaAddressTinyResponseResponseBody": { "description": "A minified Address object", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "Id of the address", "example": "494123", "type": "string" }, "name": { "description": "Name of the address", "example": "Company Office #1", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "GoaAttributeTiny": { "description": "Attribute properties.", "properties": { "id": { "description": "Id of the attribute", "example": "494123", "type": "string" }, "name": { "description": "Name of the attribute", "example": "Compliance/ELD", "type": "string" }, "numberValues": { "description": "List of number values associated with the attribute", "example": [867, 5309], "items": { "example": 0.301696114033865, "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "List of string values associated with the attribute.", "example": [ "HQ", "Leased" ], "items": { "example": "Nobis dolores nam est et praesentium.", "type": "string" }, "type": "array" } }, "type": "object" }, "GoaAttributeTinyRequestBody": { "description": "Attribute properties.", "properties": { "id": { "description": "Id of the attribute", "example": "494123", "type": "string" }, "name": { "description": "Name of the attribute", "example": "Compliance/ELD", "type": "string" }, "numberValues": { "description": "List of number values associated with the attribute", "example": [867, 5309], "items": { "example": 0.280927857455027, "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "List of string values associated with the attribute.", "example": [ "HQ", "Leased" ], "items": { "example": "Voluptas inventore.", "type": "string" }, "type": "array" } }, "type": "object" }, "GoaAttributeTinyResponseBody": { "description": "Attribute properties.", "properties": { "id": { "description": "Id of the attribute", "example": "494123", "type": "string" }, "name": { "description": "Name of the attribute", "example": "Compliance/ELD", "type": "string" }, "numberValues": { "description": "List of number values associated with the attribute", "example": [867, 5309], "items": { "example": 0.740568559863335, "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "List of string values associated with the attribute.", "example": [ "HQ", "Leased" ], "items": { "example": "Tempora dolorum placeat.", "type": "string" }, "type": "array" } }, "type": "object" }, "GoaDocumentTinyResponseResponseBody": { "description": "A minified Document object", "properties": { "id": { "description": "Id of the document", "example": "494123", "type": "string" }, "name": { "description": "Name of the document", "example": "Fuel Receipt Wichita", "type": "string" } }, "required": [ "id" ], "type": "object" }, "GoaDocumentTypeTinyResponseResponseBody": { "description": "A minified document type object", "properties": { "id": { "description": "ID of the document type.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "name": { "description": "Name of the document type.", "example": "Fleet Truck List", "type": "string" } }, "type": "object" }, "GoaDriverTinyResponseResponseBody": { "description": "A minified driver object. This object is only returned if the route is assigned to the driver.", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the driver", "example": "45646", "type": "string" }, "name": { "description": "Name of the driver", "example": "Driver Bob", "type": "string" } }, "required": [ "id" ], "type": "object" }, "GoaGatewayTinyResponseResponseBody": { "description": "A minified gateway object", "properties": { "model": { "description": "The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `SG1B`, `SG1G`, `SG1G32`, `SG1x`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG34M`, `VG54ATT`, `VG54EU`, `VG54FN`, `VG54NA`, `VG54NAE`, `VG54NAH`, `VG55EU`, `VG55FN`, `VG55NA`", "enum": [ "AG15", "AG24", "AG24EU", "AG26", "AG26EU", "AG41", "AG41EU", "AG45", "AG45EU", "AG46", "AG46EU", "AG46P", "AG46PEU", "AG51", "AG51EU", "AG52", "AG52EU", "AG53", "AG53EU", "IG15", "IG21", "IG41", "IG61", "SG1", "SG1B", "SG1G", "SG1G32", "SG1x", "VG32", "VG33", "VG34", "VG34EU", "VG34FN", "VG34M", "VG54ATT", "VG54EU", "VG54FN", "VG54NA", "VG54NAE", "VG54NAH", "VG55EU", "VG55FN", "VG55NA" ], "example": "VG34", "type": "string" }, "serial": { "description": "The serial number of the gateway installed on the asset.", "example": "GFRV-43N-VGX", "type": "string" } }, "required": [ "model", "serial" ], "type": "object" }, "GoaPaginationResponseResponseBody": { "description": "Pagination parameters.", "properties": { "endCursor": { "description": "Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.", "example": "MjkY", "type": "string" }, "hasNextPage": { "description": "True if there are more pages of results immediately available after this endCursor.", "example": true, "type": "boolean" } }, "required": [ "endCursor", "hasNextPage" ], "type": "object" }, "GoaPaginationWithTokensResponseResponseBody": { "description": "Pagination parameters.", "properties": { "endCursor": { "description": "Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.", "example": "MjkY", "type": "string" }, "hasNextPage": { "description": "True if there are more pages of results immediately available after this endCursor.", "example": true, "type": "boolean" } }, "required": [ "hasNextPage" ], "type": "object" }, "GoaRouteStopTinyResponseResponseBody": { "description": "A minified route stop object", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "Id of the route stop", "example": "494123", "type": "string" }, "name": { "description": "Name of the route stop", "example": "Company Warehouse #1", "type": "string" } }, "type": "object" }, "GoaRouteTinyResponseResponseBody": { "description": "A minified representation of a single route.", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "Unique identifier for the route.", "example": "131313", "type": "string" }, "name": { "description": "Name of the route.", "example": "Pineapple delivery", "maxLength": 255, "type": "string" } }, "required": [ "id" ], "type": "object" }, "GoaTagTinyResponseRequestBody": { "description": "A minified tag object", "properties": { "id": { "description": "ID of the tag", "example": "3914", "type": "string" }, "name": { "description": "Name of the tag.", "example": "East Coast", "type": "string" }, "parentTagId": { "description": "If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.", "example": "4815", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "GoaTagTinyResponseResponseBody": { "description": "A minified tag object", "properties": { "id": { "description": "ID of the tag", "example": "3914", "type": "string" }, "name": { "description": "Name of the tag.", "example": "East Coast", "type": "string" }, "parentTagId": { "description": "If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.", "example": "4815", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "GoaTrailerTinyResponseResponseBody": { "description": "A minified trailer object", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the trailer", "example": "494123", "type": "string" }, "name": { "description": "Name of the trailer", "example": "Fleet Truck #1", "type": "string" } }, "type": "object" }, "GoaVehicleTinyResponseResponseBody": { "description": "A minified vehicle object. This object is only returned if the route is assigned to the vehicle.", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the vehicle", "example": "494123", "type": "string" }, "name": { "description": "Name of the vehicle", "example": "Fleet Truck #1", "type": "string" } }, "type": "object" }, "GpsSignalLossDetailsObjectRequestBody": { "description": "Details specific to GPS Signal Loss", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "GpsSignalLossDetailsObjectResponseBody": { "description": "Details specific to GPS Signal Loss", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "GpsSignalLossResponseBody": { "description": "Details specific to GPS Signal Loss.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "GreenBandDrivingDurationMs": { "description": "Time in efficient RPM (800 to 17000) in milliseconds.", "type": "number" }, "GrossVehicleWeight": { "description": "The gross weight of the vehicle in either pounds (lb) or kilograms (kg). Only returned for customers with commercial speed limits (CSL) enabled.", "properties": { "unit": { "description": "The unit of weight for the vehicle.", "enum": [ "lb", "kg" ], "example": "lb", "type": "string" }, "weight": { "description": "The weight value of the vehicle.", "example": 1000, "format": "int64", "type": "integer" } }, "type": "object" }, "HOSViolationTriggerDetailsObjectRequestBody": { "description": "Details specific to HOS Violation", "properties": { "maxUntilViolationMilliseconds": { "description": "Alert if driver has this specified time until driving causes an HOS violation.", "example": 600000, "format": "int64", "type": "integer" }, "violation": { "description": "The type of HOS violation. Valid values: `CaliforniaMealbreakMissed`, `CycleHoursOn`, `DailyDrivingHours`, `DailyOnDutyHours`, `Invalid`, `RestbreakMissed`, `ShiftDrivingHours`, `ShiftHours`, `ShiftOnDutyHours`, `UnsubmittedLogs`", "enum": [ "CaliforniaMealbreakMissed", "CycleHoursOn", "DailyDrivingHours", "DailyOnDutyHours", "Invalid", "RestbreakMissed", "ShiftDrivingHours", "ShiftHours", "ShiftOnDutyHours", "UnsubmittedLogs" ], "example": "CaliforniaMealbreakMissed", "type": "string" } }, "required": [ "maxUntilViolationMilliseconds", "violation" ], "type": "object" }, "HOSViolationTriggerDetailsObjectResponseBody": { "description": "Details specific to HOS Violation", "properties": { "maxUntilViolationMilliseconds": { "description": "Alert if driver has this specified time until driving causes an HOS violation.", "example": 600000, "format": "int64", "type": "integer" }, "violation": { "description": "The type of HOS violation. Valid values: `CaliforniaMealbreakMissed`, `CycleHoursOn`, `DailyDrivingHours`, `DailyOnDutyHours`, `Invalid`, `RestbreakMissed`, `ShiftDrivingHours`, `ShiftHours`, `ShiftOnDutyHours`, `UnsubmittedLogs`", "enum": [ "CaliforniaMealbreakMissed", "CycleHoursOn", "DailyDrivingHours", "DailyOnDutyHours", "Invalid", "RestbreakMissed", "ShiftDrivingHours", "ShiftHours", "ShiftOnDutyHours", "UnsubmittedLogs" ], "example": "CaliforniaMealbreakMissed", "type": "string" } }, "required": [ "maxUntilViolationMilliseconds", "violation" ], "type": "object" }, "HarshAccelSensitivityGForceSettingsObjectResponseBody": { "description": "The harsh acceleration sensitivity settings.", "properties": { "heavyDuty": { "description": "Harsh acceleration sensitivity settings for heavy duty vehicle.", "example": "0.29", "type": "string" }, "lightDuty": { "description": "Harsh acceleration sensitivity settings for light duty vehicle.", "example": "0.33", "type": "string" }, "passenger": { "description": "Harsh acceleration sensitivity settings for passenger car.", "example": "0.43", "type": "string" } }, "type": "object" }, "HarshAccelSensitivityV2SettingsObjectResponseBody": { "description": "The harsh acceleration sensitivity settings.", "properties": { "heavyDuty": { "description": "Harsh acceleration sensitivity settings for heavy duty vehicle. Valid values: `unknown`, `invalid`, `off`, `low`, `normal`, `high`", "enum": [ "unknown", "invalid", "off", "low", "normal", "high" ], "example": "normal", "type": "string" }, "lightDuty": { "description": "Harsh acceleration sensitivity settings for light duty vehicle. Valid values: `unknown`, `invalid`, `off`, `low`, `normal`, `high`", "enum": [ "unknown", "invalid", "off", "low", "normal", "high" ], "example": "normal", "type": "string" }, "passenger": { "description": "Harsh acceleration sensitivity settings for passenger car. Valid values: `unknown`, `invalid`, `off`, `low`, `normal`, `high`", "enum": [ "unknown", "invalid", "off", "low", "normal", "high" ], "example": "normal", "type": "string" } }, "type": "object" }, "HarshBrakeSensitivityGForceSettingsObjectResponseBody": { "description": "The harsh brake sensitivity settings.", "properties": { "heavyDuty": { "description": "Harsh brake sensitivity settings for heavy duty vehicle.", "example": "0.29", "type": "string" }, "lightDuty": { "description": "Harsh brake sensitivity settings for light duty vehicle.", "example": "0.33", "type": "string" }, "passenger": { "description": "Harsh brake sensitivity settings for passenger car.", "example": "0.43", "type": "string" } }, "type": "object" }, "HarshBrakeSensitivityV2SettingsObjectResponseBody": { "description": "The harsh brake sensitivity settings.", "properties": { "heavyDuty": { "description": "Harsh brake sensitivity settings for heavy duty vehicle. Valid values: `unknown`, `invalid`, `off`, `veryLow`, `low`, `normal`, `high`", "enum": [ "unknown", "invalid", "off", "veryLow", "low", "normal", "high" ], "example": "normal", "type": "string" }, "lightDuty": { "description": "Harsh brake sensitivity settings for light duty vehicle. Valid values: `unknown`, `invalid`, `off`, `veryLow`, `low`, `normal`, `high`", "enum": [ "unknown", "invalid", "off", "veryLow", "low", "normal", "high" ], "example": "normal", "type": "string" }, "passenger": { "description": "Harsh brake sensitivity settings for passenger car. Valid values: `unknown`, `invalid`, `off`, `veryLow`, `low`, `normal`, `high`", "enum": [ "unknown", "invalid", "off", "veryLow", "low", "normal", "high" ], "example": "normal", "type": "string" } }, "type": "object" }, "HarshEventDataResponseBody": { "description": "Details specific to Harsh Event.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "HarshEventSensitivitySettingsObjectResponseBody": { "description": "The configurable sensitivity for Harsh Event Detection on CM11/CM12/CM22 devices. Sensitivity can be measured as a numeric g-force value or the following values: `Normal`, `Less Sensitive`, `More Sensitive`.", "properties": { "harshAccelSensitivityGForce": { "$ref": "#/components/schemas/HarshAccelSensitivityGForceSettingsObjectResponseBody" }, "harshBrakeSensitivityGForce": { "$ref": "#/components/schemas/HarshBrakeSensitivityGForceSettingsObjectResponseBody" }, "harshTurnSensitivityGForce": { "$ref": "#/components/schemas/HarshTurnSensitivityGForceSettingsObjectResponseBody" } }, "type": "object" }, "HarshEventSensitivityV2SettingsObjectResponseBody": { "description": "The configurable sensitivity for Harsh Event Detection. Does not apply to CM11/12/22 devices.", "properties": { "harshAccelSensitivity": { "$ref": "#/components/schemas/HarshAccelSensitivityV2SettingsObjectResponseBody" }, "harshBrakeSensitivity": { "$ref": "#/components/schemas/HarshBrakeSensitivityV2SettingsObjectResponseBody" }, "harshTurnSensitivity": { "$ref": "#/components/schemas/HarshTurnSensitivityV2SettingsObjectResponseBody" } }, "type": "object" }, "HarshEventTriggerDetailsObjectRequestBody": { "description": "Details specific to Harsh Events", "properties": { "types": { "description": "On which harsh events to trigger on.", "example": [ "haFoodPolicy", "haPolicyDetector", "haRolloverProtectionEngineControlActivated", "haLaneDeparture" ], "items": { "description": "The type of harsh event. Valid values: `haAccel`, `haBraking`, `haCameraMisaligned`, `haCrash`, `haDistractedDriving`, `haDistractedDrivingCalibration`, `haDrinkPolicy`, `haDriverObstructionPolicy`, `haDrowsinessDetection`, `haEvent`, `haFalsePositive`, `haFoodPolicy`, `haInvalid`, `haLaneDeparture`, `haMaskPolicy`, `haNearCollision`, `haOutwardObstructionPolicy`, `haPassengerPolicy`, `haPhonePolicy`, `haPolicyDetector`, `haRearCollisionWarning`, `haRolledStopSign`, `haRollover`, `haRolloverProtectionBrakeControlActivated`, `haRolloverProtectionEngineControlActivated`, `haSeatbeltPolicy`, `haSharpTurn`, `haSignDetection`, `haSmokingPolicy`, `haSpeeding`, `haTailgating`, `haTileRollingRailroadCrossing`, `haTileRollingStopSign`, `haVulnerableRoadUserCollisionWarning`, `haYawControlBrakeControlActivated`, `haYawControlEngineControlActivated`", "enum": [ "haAccel", "haBraking", "haCameraMisaligned", "haCrash", "haDistractedDriving", "haDistractedDrivingCalibration", "haDrinkPolicy", "haDriverObstructionPolicy", "haDrowsinessDetection", "haEvent", "haFalsePositive", "haFoodPolicy", "haInvalid", "haLaneDeparture", "haMaskPolicy", "haNearCollision", "haOutwardObstructionPolicy", "haPassengerPolicy", "haPhonePolicy", "haPolicyDetector", "haRearCollisionWarning", "haRolledStopSign", "haRollover", "haRolloverProtectionBrakeControlActivated", "haRolloverProtectionEngineControlActivated", "haSeatbeltPolicy", "haSharpTurn", "haSignDetection", "haSmokingPolicy", "haSpeeding", "haTailgating", "haTileRollingRailroadCrossing", "haTileRollingStopSign", "haVulnerableRoadUserCollisionWarning", "haYawControlBrakeControlActivated", "haYawControlEngineControlActivated" ], "example": "haDrinkPolicy", "type": "string" }, "type": "array" } }, "required": [ "types" ], "type": "object" }, "HarshEventTriggerDetailsObjectResponseBody": { "description": "Details specific to Harsh Events", "properties": { "types": { "description": "On which harsh events to trigger on.", "example": [ "haRollover", "haRolloverProtectionEngineControlActivated" ], "items": { "description": "The type of harsh event. Valid values: `haAccel`, `haBraking`, `haCameraMisaligned`, `haCrash`, `haDistractedDriving`, `haDistractedDrivingCalibration`, `haDrinkPolicy`, `haDriverObstructionPolicy`, `haDrowsinessDetection`, `haEvent`, `haFalsePositive`, `haFoodPolicy`, `haInvalid`, `haLaneDeparture`, `haMaskPolicy`, `haNearCollision`, `haOutwardObstructionPolicy`, `haPassengerPolicy`, `haPhonePolicy`, `haPolicyDetector`, `haRearCollisionWarning`, `haRolledStopSign`, `haRollover`, `haRolloverProtectionBrakeControlActivated`, `haRolloverProtectionEngineControlActivated`, `haSeatbeltPolicy`, `haSharpTurn`, `haSignDetection`, `haSmokingPolicy`, `haSpeeding`, `haTailgating`, `haTileRollingRailroadCrossing`, `haTileRollingStopSign`, `haVulnerableRoadUserCollisionWarning`, `haYawControlBrakeControlActivated`, `haYawControlEngineControlActivated`", "enum": [ "haAccel", "haBraking", "haCameraMisaligned", "haCrash", "haDistractedDriving", "haDistractedDrivingCalibration", "haDrinkPolicy", "haDriverObstructionPolicy", "haDrowsinessDetection", "haEvent", "haFalsePositive", "haFoodPolicy", "haInvalid", "haLaneDeparture", "haMaskPolicy", "haNearCollision", "haOutwardObstructionPolicy", "haPassengerPolicy", "haPhonePolicy", "haPolicyDetector", "haRearCollisionWarning", "haRolledStopSign", "haRollover", "haRolloverProtectionBrakeControlActivated", "haRolloverProtectionEngineControlActivated", "haSeatbeltPolicy", "haSharpTurn", "haSignDetection", "haSmokingPolicy", "haSpeeding", "haTailgating", "haTileRollingRailroadCrossing", "haTileRollingStopSign", "haVulnerableRoadUserCollisionWarning", "haYawControlBrakeControlActivated", "haYawControlEngineControlActivated" ], "example": "haInvalid", "type": "string" }, "type": "array" } }, "required": [ "types" ], "type": "object" }, "HarshTurnSensitivityGForceSettingsObjectResponseBody": { "description": "The harsh turn sensitivity settings.", "properties": { "heavyDuty": { "description": "Harsh turn sensitivity settings for heavy duty vehicle.", "example": "0.29", "type": "string" }, "lightDuty": { "description": "Harsh turn sensitivity settings for light duty vehicle.", "example": "0.33", "type": "string" }, "passenger": { "description": "Harsh turn sensitivity settings for passenger car.", "example": "0.43", "type": "string" } }, "type": "object" }, "HarshTurnSensitivityV2SettingsObjectResponseBody": { "description": "The harsh turn sensitivity settings.", "properties": { "heavyDuty": { "description": "Harsh turn sensitivity settings for heavy duty vehicle. Valid values: `unknown`, `invalid`, `off`, `veryLow`, `low`, `normal`, `high`", "enum": [ "unknown", "invalid", "off", "veryLow", "low", "normal", "high" ], "example": "normal", "type": "string" }, "lightDuty": { "description": "Harsh turn sensitivity settings for light duty vehicle. Valid values: `unknown`, `invalid`, `off`, `veryLow`, `low`, `normal`, `high`", "enum": [ "unknown", "invalid", "off", "veryLow", "low", "normal", "high" ], "example": "normal", "type": "string" }, "passenger": { "description": "Harsh turn sensitivity settings for passenger car. Valid values: `unknown`, `invalid`, `off`, `veryLow`, `low`, `normal`, `high`", "enum": [ "unknown", "invalid", "off", "veryLow", "low", "normal", "high" ], "example": "normal", "type": "string" } }, "type": "object" }, "HealthDetailsResponseResponseBody": { "description": "Detailed health related metadata for the device.", "properties": { "cameraDetails": { "$ref": "#/components/schemas/CameraDetailsResponseResponseBody" }, "gatewayDetails": { "$ref": "#/components/schemas/GatewayDetailsResponseResponseBody" } }, "type": "object" }, "HealthReasonResponseResponseBody": { "description": "Information about an active health reason affecting the device.", "properties": { "healthReasonCode": { "description": "The type of health reason detected. Valid values: `assetUnplugged`, `cameraMisaligned`, `healthy`, `inwardCameraObstruction`, `irregularRecording`, `lowDeviceBattery`, `missingEldDiagnostics`, `missingVin`, `needsReplacement`, `newlyInstalledDevice`, `noGpsSignal`, `notDetected`, `outwardCameraObstruction`, `recordingTimeRequired`, `unknown`, `vgUnplugged`", "enum": [ "assetUnplugged", "cameraMisaligned", "healthy", "inwardCameraObstruction", "irregularRecording", "lowDeviceBattery", "missingEldDiagnostics", "missingVin", "needsReplacement", "newlyInstalledDevice", "noGpsSignal", "notDetected", "outwardCameraObstruction", "recordingTimeRequired", "unknown", "vgUnplugged" ], "example": "assetUnplugged", "type": "string" }, "startTime": { "description": "The timestamp when this health reason began, in RFC3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "type": "object" }, "HealthResponseResponseBody": { "description": "Health information for the device.", "properties": { "healthDetails": { "$ref": "#/components/schemas/HealthDetailsResponseResponseBody" }, "healthReasons": { "description": "The list of active health reasons affecting this device.", "items": { "$ref": "#/components/schemas/HealthReasonResponseResponseBody" }, "type": "array" }, "healthStatus": { "description": "Current overall health status of the device. Valid values: `dataPending`, `healthy`, `needsAttention`, `needsReplacement`", "enum": [ "dataPending", "healthy", "needsAttention", "needsReplacement" ], "example": "dataPending", "type": "string" }, "primaryHealthReason": { "description": "Primary health reason affecting the device's current health status. Valid values: `assetUnplugged`, `cameraMisaligned`, `healthy`, `inwardCameraObstruction`, `irregularRecording`, `lowDeviceBattery`, `missingEldDiagnostics`, `missingVin`, `needsReplacement`, `newlyInstalledDevice`, `noGpsSignal`, `notDetected`, `outwardCameraObstruction`, `recordingTimeRequired`, `unknown`, `vgUnplugged`", "enum": [ "assetUnplugged", "cameraMisaligned", "healthy", "inwardCameraObstruction", "irregularRecording", "lowDeviceBattery", "missingEldDiagnostics", "missingVin", "needsReplacement", "newlyInstalledDevice", "noGpsSignal", "notDetected", "outwardCameraObstruction", "recordingTimeRequired", "unknown", "vgUnplugged" ], "example": "assetUnplugged", "type": "string" }, "primaryHealthReasonStartTime": { "description": "The timestamp when the primary health reason began, in RFC3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "recommendedAction": { "description": "Recommended steps to resolve the current health reason.\n\n* `recommendedActionAgHealthy`: Gateway is healthy. No action required.\n* `recommendedActionAgLowDeviceBatteryAG45`: The gateway battery is low. Please contact support\n* `recommendedActionAgLowDeviceBatteryAG46`: The gateway battery is low. Gateway batteries require replacement.\n* `recommendedActionAgLowDeviceBatteryAG51`: Gateway batteries require replacement.\n* `recommendedActionAgLowDeviceBatteryPoweredAG`: The gateway battery is low. Power on the asset to charge the gateway.\n* `recommendedActionAgNoGpsSignal`: Gateway has no GPS signal. Verify that the gateway is securely attached to the exterior of the asset. Ensure that the device is outside and avoid obstructions such as underground structures, heavily insulated buildings, bridges, and trees.\n* `recommendedActionAgNotDetected`: The gateway has not been detected for at least 24 hours. See troubleshooting steps to reboot the gateway.\n* `recommendedActionAgUnplugged`: The asset gateway is unplugged or cut. Check the gateway connection to ensure it is plugged in and has been installed correctly\n* `recommendedActionCmCameraMisaligned`: The position of the road-facing dash cam is not aligned with the horizon. Video quality and AI detection may be impacted. Reposition dash cam and Test Dash Cam Positioning.\n* `recommendedActionCmHealthy`: Dash cam recording is healthy. No action required.\n* `recommendedActionCmInwardCameraObstruction`: The inward-facing dash cam does not have a clear view of the vehicle cab. Video quality and AI detection may be impacted. Remove obstruction and Test Dash Cam Positioning.\n* `recommendedActionCmIrregularRecording`: The dash cam is not working as expected. Please contact Support.\n* `recommendedActionCmNewlyInstalledDevice`: This dash cam has recently been installed and at least 30 hours of recording time is required to calculate health. No action required.\n* `recommendedActionCmNotDetected`: The dash cam has not been detected for at least 24 hours. Check the dash cam's connection and verify your dash cam has been installed correctly.\n* `recommendedActionCmOutwardCameraObstruction`: The outward-facing dash cam does not have a clear view of the road. Video quality and AI detection may be impacted Remove obstruction and Test Dash Cam Positioning.\n* `recommendedActionCmRecordingTimeRequired`: At least 30 hours of recording time is required to determine device health. No action required.\n* `recommendedActionCmVgUnplugged`: The vehicle gateway is unplugged and the dash cam health cannot be determined. Check the vehicle gateway connection and ensure it is plugged in and has been installed correctly.\n* `recommendedActionGatewayNewlyInstalledDevice`: This gateway has recently been installed and more data is required to calculate health. No action required.\n* `recommendedActionVgHealthy`: Gateway is healthy. No action required.\n* `recommendedActionVgMissingEldDiagnostics`: To ensure full compliance, request exchange.\n* `recommendedActionVgMissingEldDiagnosticsExchangeSubmitted`: Exchange submitted. Please allow 12-24 hours for exchange to appear in the orders and exchanges page.\n* `recommendedActionVgMissingEldDiagnosticsHardwareExchanged`: Install exchanged hardware.\n* `recommendedActionVgMissingEldDiagnosticsNoExchangeSubmitted`: To ensure full compliance, request exchange.\n* `recommendedActionVgMissingVin`: Add the VIN to your vehicle.\n* `recommendedActionVgNeedsReplacement`: To ensure full compliance, request exchange.\n* `recommendedActionVgNotDetected`: The vehicle gateway has not been detected for at least 24 hours. Check the vehicle gateway connection to ensure it is plugged in and view additional troubleshooting steps.\n* `recommendedActionVgVgUnplugged`: The vehicle gateway is unplugged. Check the vehicle gateway connection to ensure it is plugged in and has been installed correctly.\n* `unknown`: None\n\n\n Valid values: `recommendedActionAgHealthy`, `recommendedActionAgLowDeviceBatteryAG45`, `recommendedActionAgLowDeviceBatteryAG46`, `recommendedActionAgLowDeviceBatteryAG51`, `recommendedActionAgLowDeviceBatteryPoweredAG`, `recommendedActionAgNoGpsSignal`, `recommendedActionAgNotDetected`, `recommendedActionAgUnplugged`, `recommendedActionCmCameraMisaligned`, `recommendedActionCmHealthy`, `recommendedActionCmInwardCameraObstruction`, `recommendedActionCmIrregularRecording`, `recommendedActionCmNewlyInstalledDevice`, `recommendedActionCmNotDetected`, `recommendedActionCmOutwardCameraObstruction`, `recommendedActionCmRecordingTimeRequired`, `recommendedActionCmVgUnplugged`, `recommendedActionGatewayNewlyInstalledDevice`, `recommendedActionVgHealthy`, `recommendedActionVgMissingEldDiagnostics`, `recommendedActionVgMissingEldDiagnosticsExchangeSubmitted`, `recommendedActionVgMissingEldDiagnosticsHardwareExchanged`, `recommendedActionVgMissingEldDiagnosticsNoExchangeSubmitted`, `recommendedActionVgMissingVin`, `recommendedActionVgNeedsReplacement`, `recommendedActionVgNotDetected`, `recommendedActionVgVgUnplugged`, `unknown`", "enum": [ "recommendedActionAgHealthy", "recommendedActionAgLowDeviceBatteryAG45", "recommendedActionAgLowDeviceBatteryAG46", "recommendedActionAgLowDeviceBatteryAG51", "recommendedActionAgLowDeviceBatteryPoweredAG", "recommendedActionAgNoGpsSignal", "recommendedActionAgNotDetected", "recommendedActionAgUnplugged", "recommendedActionCmCameraMisaligned", "recommendedActionCmHealthy", "recommendedActionCmInwardCameraObstruction", "recommendedActionCmIrregularRecording", "recommendedActionCmNewlyInstalledDevice", "recommendedActionCmNotDetected", "recommendedActionCmOutwardCameraObstruction", "recommendedActionCmRecordingTimeRequired", "recommendedActionCmVgUnplugged", "recommendedActionGatewayNewlyInstalledDevice", "recommendedActionVgHealthy", "recommendedActionVgMissingEldDiagnostics", "recommendedActionVgMissingEldDiagnosticsExchangeSubmitted", "recommendedActionVgMissingEldDiagnosticsHardwareExchanged", "recommendedActionVgMissingEldDiagnosticsNoExchangeSubmitted", "recommendedActionVgMissingVin", "recommendedActionVgNeedsReplacement", "recommendedActionVgNotDetected", "recommendedActionVgVgUnplugged", "unknown" ], "example": "recommendedActionAgHealthy", "type": "string" } }, "type": "object" }, "HighTorqueMs": { "description": "Time the vehicle engine torque is greater than 90% in milliseconds.", "type": "number" }, "HosBreak": { "description": "Remaining durations for the HOS rest break requirement.", "properties": { "timeUntilBreakDurationMs": { "description": "Time until the driver has a required break in milliseconds.", "example": 28800000, "type": "number" } }, "type": "object" }, "HosClocks": { "description": "Remaining durations and start times (where applicable) for various HOS rules. See [this page](https://www.samsara.com/fleet/eld-compliance/hours-of-service) for more information on HOS rules.", "properties": { "break": { "$ref": "#/components/schemas/HosBreak" }, "cycle": { "$ref": "#/components/schemas/HosCycle" }, "drive": { "$ref": "#/components/schemas/HosDrive" }, "shift": { "$ref": "#/components/schemas/HosShift" } }, "type": "object" }, "HosClocksForDriver": { "description": "HOS clock values for a specific driver, including remaining times and violations.", "properties": { "clocks": { "$ref": "#/components/schemas/HosClocks" }, "currentDutyStatus": { "$ref": "#/components/schemas/CurrentDutyStatus" }, "currentVehicle": { "$ref": "#/components/schemas/vehicleTinyResponse" }, "driver": { "$ref": "#/components/schemas/driverTinyResponse" }, "violations": { "$ref": "#/components/schemas/HosViolations" } }, "type": "object" }, "HosClocksForDrivers": { "description": "List of HOS clocks for the specified drivers.", "items": { "$ref": "#/components/schemas/HosClocksForDriver" }, "type": "array" }, "HosClocksResponse": { "description": "Drivers HOS clocks and pagination info.", "properties": { "data": { "$ref": "#/components/schemas/HosClocksForDrivers" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "HosCycle": { "description": "Remaining durations and start time for the HOS driving cycle.", "properties": { "cycleRemainingDurationMs": { "description": "Remaining on duty or driving time the driver has in the current cycle in milliseconds. For property-carrying drivers, this is the amount of time the driver can be on duty or driving before hitting the 60/70-hour limit in 7/8 days.", "example": 252000000, "type": "number" }, "cycleStartedAtTime": { "$ref": "#/components/schemas/time" }, "cycleTomorrowDurationMs": { "description": "Remaining on duty or driving time the driver has available tomorrow in milliseconds. For property-carrying drivers this is calculated based on the 60/70-hour limit in 7/8 days rule.", "example": 252000000, "type": "number" } }, "type": "object" }, "HosDailyLogsGetHosDailyLogsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsResponseBody": { "properties": { "data": { "description": "List of drivers and their HOS daily logs data.", "items": { "$ref": "#/components/schemas/HosDailyLogsObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsGetHosDailyLogsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsObjectResponseBody": { "properties": { "distanceTraveled": { "$ref": "#/components/schemas/DistanceTraveledObjectResponseBody" }, "driver": { "$ref": "#/components/schemas/DriverWithTimezoneEldSettingsObjectResponseBody" }, "dutyStatusDurations": { "$ref": "#/components/schemas/DutyStatusDurationObjectResponseBody" }, "endTime": { "description": "The end time of the daily log in RFC 3339 format. This will be calculated using timezone of the driver.", "example": "2019-06-20T19:08:25Z", "type": "string" }, "logMetaData": { "$ref": "#/components/schemas/LogMetaDataObjectResponseBody" }, "pendingDutyStatusDurations": { "$ref": "#/components/schemas/PendingDutyStatusDurationsObjectResponseBody" }, "startTime": { "description": "The start time of the daily log in RFC 3339 format. This will be calculated using timezone of the driver.", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "required": [ "driver", "endTime", "startTime" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsRequestBody": { "description": "Update the shippingDocs field.", "properties": { "shippingDocs": { "description": "ShippingDocs associated with the driver for the day.", "example": "ShippingID1, ShippingID2", "type": "string" } }, "required": [ "shippingDocs" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PatchShippingDocsResponseBodyResponseBody" } }, "required": [ "data" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDailyLogsUpdateShippingDocsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosDrive": { "description": "Remaining durations for the HOS driving shift limits.", "properties": { "driveRemainingDurationMs": { "description": "Remaining driving time the driver has in the current shift in milliseconds. For property-carrying drivers, this is the amount of time the driver can drive before hitting the 11-hour limit.", "example": 39600000, "type": "number" } }, "type": "object" }, "HosDriversEldEventObjectResponseBody": { "properties": { "driverActivationStatus": { "description": "A value indicating whether the driver is active or deactivated. Valid values: `active`, `deactivated`", "enum": [ "active", "deactivated" ], "example": "active", "type": "string" }, "eldEvents": { "description": "List of ELD event objects.", "items": { "$ref": "#/components/schemas/HosEldEventObjectResponseBody" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the driver.", "example": "494123", "type": "string" }, "name": { "description": "Name of the driver.", "example": "Joe Driver", "type": "string" } }, "required": [ "driverActivationStatus", "eldEvents", "id", "name" ], "type": "object" }, "HosEldEventLocationObjectResponseBody": { "properties": { "city": { "description": "The best effort city for the latitude and longitude.", "example": "San Francisco", "type": "string" }, "eldLocation": { "description": "Relative location to the city, village, or town with population of 5,000 or greater.", "example": "3.1 mi WSW San Francisco, CA", "type": "string" }, "latitude": { "description": "The latitude of the location.", "example": 123.456, "format": "double", "type": "number" }, "longitude": { "description": "The longitude of the location.", "example": 37.459, "format": "double", "type": "number" }, "state": { "description": "The best effort state for the latitude and longitude.", "example": "CA", "type": "string" } }, "type": "object" }, "HosEldEventObjectResponseBody": { "description": "An event that refers to a discrete instance in time with various data elements. Depending on the type of event, not every field will be populated. For more information, see the ELD Mandate [section 3.1.2](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a).", "properties": { "accumulatedVehicleMeters": { "description": "The accumulated meters in the given ignition power on cycle.", "example": 106, "format": "int64", "type": "integer" }, "elapsedEngineHours": { "description": "The elapsed time in the engine's operation in the given ignition power on cycle.", "example": 284.1, "format": "double", "type": "number" }, "eldEventCode": { "description": "A dependent attribute on `eldEventType` that specifies the nature of the event, as defined in the ELD Mandate [section 7.20](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `1`, `2`, `3`, `4`, `5`, `6`, `7`, `8`, `9`", "example": 3, "maximum": 9, "minimum": 1, "type": "integer" }, "eldEventRecordOrigin": { "description": "An attribute for the event record indicating whether it is automatically recorded, or edited, entered or accepted by the driver, requested by another authenticated user, or assumed from unidentified driver profile, as defined in the ELD Mandate [section 7.22](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `1`, `2`, `3`, `4`", "example": 2, "maximum": 4, "minimum": 1, "type": "integer" }, "eldEventRecordStatus": { "description": "An attribute for the event record indicating whether an event is active or inactive and further, if inactive, whether it is due to a change or lack of confirmation by the driver or due to a driver's rejection of change request, as defined in the ELD Mandate [section 7.23](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `1`, `2`, `3`, `4`", "example": 2, "maximum": 4, "minimum": 1, "type": "integer" }, "eldEventType": { "description": "An attribute specifying the type of ELD event, as defined in the ELD Mandate [section 7.25](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `1`, `2`, `3`, `4`, `5`, `6`, `7`", "example": 6, "maximum": 7, "minimum": 1, "type": "integer" }, "location": { "$ref": "#/components/schemas/HosEldEventLocationObjectResponseBody" }, "malfunctionDiagnosticCode": { "description": "A code that further specifies the underlying malfunction or data diagnostic event, as defined in the ELD Mandate [section 7.34](https://www.ecfr.gov/cgi-bin/retrieveECFR?gp=1&ty=HTML&h=L&mc=true&=PART&n=pt49.5.395#ap49.5.395_138.a). Valid values: `P`, `E`, `T`, `L`, `R`, `S`, `O`, `1`, `2`, `3`, `4`, `5`, `6`", "enum": [ "P", "E", "T", "L", "R", "S", "O", "1", "2", "3", "4", "5", "6" ], "example": "P", "type": "string" }, "remark": { "$ref": "#/components/schemas/HosEldEventRemarkObjectResponseBody" }, "time": { "description": "A time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "totalEngineHours": { "description": "The aggregated time of a vehicle's engine's operation since its inception.", "example": 2894.1, "format": "double", "type": "number" }, "totalVehicleMeters": { "description": "The total meters recorded for the vehicle.", "example": 1004566, "format": "int64", "type": "integer" }, "vehicle": { "$ref": "#/components/schemas/GoaVehicleTinyResponseResponseBody" } }, "required": [ "eldEventCode", "eldEventType", "time" ], "type": "object" }, "HosEldEventRemarkObjectResponseBody": { "properties": { "comment": { "description": "The content of the remark.", "example": "Pre-Trip Inspection", "type": "string" }, "locationDescription": { "description": "The location description entered by the user", "example": "Near San Francisco", "type": "string" }, "time": { "description": "The time in RFC 3339 format at which the remark was created.", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "required": [ "comment", "locationDescription", "time" ], "type": "object" }, "HosEldEventsGetHosEldEventsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosEldEventsGetHosEldEventsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosEldEventsGetHosEldEventsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosEldEventsGetHosEldEventsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosEldEventsGetHosEldEventsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosEldEventsGetHosEldEventsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosEldEventsGetHosEldEventsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosEldEventsGetHosEldEventsResponseBody": { "properties": { "data": { "description": "List of drivers and their ELD event objects data.", "items": { "$ref": "#/components/schemas/HosDriversEldEventObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data" ], "type": "object" }, "HosEldEventsGetHosEldEventsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosEldEventsGetHosEldEventsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosEldEventsGetHosEldEventsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosLogEntry": { "description": "A single HOS log entry.", "properties": { "codrivers": { "description": "The codriver information.", "items": { "$ref": "#/components/schemas/driverTinyResponse" }, "type": "array" }, "hosStatusType": { "description": "The Hours of Service status type. Valid values: `offDuty`, `sleeperBed`, `driving`, `onDuty`, `yardMove`, `personalConveyance`.", "enum": [ "offDuty", "sleeperBed", "driving", "onDuty", "yardMove", "personalConveyance" ], "example": "offDuty", "type": "string" }, "logEndTime": { "$ref": "#/components/schemas/time" }, "logRecordedLocation": { "$ref": "#/components/schemas/HosLogLocation" }, "logStartTime": { "$ref": "#/components/schemas/time" }, "remark": { "description": "Remark associated with the log entry.", "example": "Lunch Break", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/vehicleTinyResponse" } }, "required": [ "logStartTime" ], "type": "object" }, "HosLogLocation": { "description": "Location associated with the duty status change", "properties": { "latitude": { "description": "GPS latitude represented in degrees", "example": 122.142, "format": "double", "type": "number" }, "longitude": { "description": "GPS longitude represented in degrees", "example": -93.343, "format": "double", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "HosLogsForDriver": { "description": "List of HOS logs for a driver.", "properties": { "driver": { "$ref": "#/components/schemas/driverTinyResponse" }, "hosLogs": { "$ref": "#/components/schemas/HosLogsList" } }, "type": "object" }, "HosLogsForDrivers": { "description": "List of HOS logs for the specified drivers.", "items": { "$ref": "#/components/schemas/HosLogsForDriver" }, "type": "array" }, "HosLogsList": { "description": "List of HOS log entries.", "items": { "$ref": "#/components/schemas/HosLogEntry" }, "type": "array" }, "HosLogsResponse": { "description": "HOS logs and pagination info.", "properties": { "data": { "$ref": "#/components/schemas/HosLogsForDrivers" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "HosShift": { "description": "Remaining durations and start time for the HOS on duty shift limits.", "properties": { "shiftRemainingDurationMs": { "description": "Remaining on duty or driving time the driver in the current shift in milliseconds. For property-carrying drivers, this is the amount of time the driver can be on duty or driving before hitting the 14-hour limit.", "example": 50400000, "type": "number" } }, "type": "object" }, "HosViolationDataResponseBody": { "description": "Details specific to Hos Violation.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" } }, "type": "object" }, "HosViolationDayObjectResponseBody": { "properties": { "endTime": { "description": "The end time of the day on which the violation occurred in RFC 3339 format. This is determined by the driver's ELD start hour (00:00 or 12:00)", "example": "2019-06-14T12:00:00Z", "type": "string" }, "startTime": { "description": "The start time of the day on which the violation occurred in RFC 3339 format. This is determined by the driver's ELD start hour (00:00 or 12:00)", "example": "2019-06-13T12:00:00Z", "type": "string" } }, "required": [ "endTime", "startTime" ], "type": "object" }, "HosViolationObjectResponseBody": { "properties": { "day": { "$ref": "#/components/schemas/HosViolationDayObjectResponseBody" }, "description": { "description": "Description containing violation type, region, and other metadata. This field can assume the following formats for the following types:\ncaliforniaMealbreakMissed, restbreakMissed: \"[description] ([max on duty hours] hours)\"\ncycleHoursOn, dailyDrivingHours, dailyOffDutyNonResetHours, dailyOffDutyTotalHours, dailyOnDutyHours, shiftDrivingHours, shiftHours, shiftOnDutyHours: \"[description] ([region]-[max hours in duty status] hours)\"\ncycleOffHoursAfterOnDutyHours: \"[description] ([region]): [minimum hours consecutive rest] hours off duty required after [max hours before consecutive rest] hours on-duty time\"\ndailyOffDutyDeferralAddToDay2Consecutive, dailyOffDutyDeferralNotPartMandatory, dailyOffDutyDeferralTwoDayDrivingLimit, dailyOffDutyDeferralTwoDayOffDuty, mandatory24HoursOffDuty: \"[description] ([region])\"\nunsubmittedLogs: \"Missing Driver Certification\"", "example": "Daily Off-Duty Time (Canada South-10 hours)", "type": "string" }, "driver": { "$ref": "#/components/schemas/GoaDriverTinyResponseResponseBody" }, "durationMs": { "description": "Duration the driver was in violation in milliseconds. This is the time between the time the driver starts being in violation until the end of the time window for violations that have one (e.g. `shiftDrivingHours`) or until the end of the day. The duration of some violations may cover the whole day (e.g. `unsubmittedLogs`).", "example": 31970000, "format": "int64", "type": "integer" }, "type": { "description": "The string value of the violation type. Valid values: `NONE`, `californiaMealbreakMissed`, `cycleHoursOn`, `cycleOffHoursAfterOnDutyHours`, `dailyDrivingHours`, `dailyOffDutyDeferralAddToDay2Consecutive`, `dailyOffDutyDeferralNotPartMandatory`, `dailyOffDutyDeferralTwoDayDrivingLimit`, `dailyOffDutyDeferralTwoDayOffDuty`, `dailyOffDutyNonResetHours`, `dailyOffDutyTotalHours`, `dailyOnDutyHours`, `mandatory24HoursOffDuty`, `restbreakMissed`, `shiftDrivingHours`, `shiftHours`, `shiftOnDutyHours`, `unsubmittedLogs`", "enum": [ "NONE", "californiaMealbreakMissed", "cycleHoursOn", "cycleOffHoursAfterOnDutyHours", "dailyDrivingHours", "dailyOffDutyDeferralAddToDay2Consecutive", "dailyOffDutyDeferralNotPartMandatory", "dailyOffDutyDeferralTwoDayDrivingLimit", "dailyOffDutyDeferralTwoDayOffDuty", "dailyOffDutyNonResetHours", "dailyOffDutyTotalHours", "dailyOnDutyHours", "mandatory24HoursOffDuty", "restbreakMissed", "shiftDrivingHours", "shiftHours", "shiftOnDutyHours", "unsubmittedLogs" ], "example": "shiftHours", "type": "string" }, "violationStartTime": { "description": "The start time of the violation in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "required": [ "day", "description", "driver", "durationMs", "type", "violationStartTime" ], "type": "object" }, "HosViolations": { "description": "Durations the driver has been in violation of HOS rules. See [this page](https://www.samsara.com/fleet/eld-compliance/hours-of-service) for more information on HOS rules.", "properties": { "cycleViolationDurationMs": { "description": "Time since the driver has surpassed the driving cycle duration limit in milliseconds. For property-carrying drivers, this is the amount of time the driver has been on duty or driving past the 60/70-hour limit in 7/8 days.", "example": 39600000, "type": "number" }, "shiftDrivingViolationDurationMs": { "description": "Time since the driver has surpassed the driving shift duration limit in milliseconds. For property-carrying drivers, this is the amount of time the driver has been driving past the 11-hour limit.", "example": 39600000, "type": "number" } }, "type": "object" }, "HosViolationsGetHosViolationsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsGetHosViolationsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsGetHosViolationsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsGetHosViolationsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsGetHosViolationsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsGetHosViolationsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsGetHosViolationsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsGetHosViolationsResponseBody": { "properties": { "data": { "description": "List of violations data", "items": { "$ref": "#/components/schemas/HosViolationsObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "HosViolationsGetHosViolationsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsGetHosViolationsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsGetHosViolationsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "HosViolationsObjectResponseBody": { "properties": { "violations": { "description": "List of violations and their associated drivers", "items": { "$ref": "#/components/schemas/HosViolationObjectResponseBody" }, "type": "array" } }, "required": [ "violations" ], "type": "object" }, "IFTACreateIftaDetailJobBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTACreateIftaDetailJobBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTACreateIftaDetailJobGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTACreateIftaDetailJobInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTACreateIftaDetailJobMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTACreateIftaDetailJobNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTACreateIftaDetailJobNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTACreateIftaDetailJobRequestBody": { "description": "The payload to create a new IftaDetailJob.", "properties": { "endHour": { "description": " An end time in RFC 3339 format. Hour precision and timezones are supported. Any minutes or seconds will be truncated down to the nearest hour. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. The maximum request duration is 1 month. Limit the number of vehicles to 1000 when requesting more than 24 hours of data. (Examples: 2019-06-13T19:00:00Z, 2019-06-13T19:00:00.000Z, OR 2015-09-15T14:00:00-04:00).", "example": "2019-06-13T19:00:00Z", "type": "string" }, "startHour": { "description": " A start time in RFC 3339 format. Hour precision and timezones are supported. Any minutes or seconds will be truncated down to the nearest hour. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. The maximum request duration is 1 month. Limit the number of vehicles to 1000 when requesting more than 24 hours of data. (Examples: 2019-06-13T19:00:00Z, 2019-06-13T19:00:00.000Z, OR 2015-09-15T14:00:00-04:00).", "example": "2019-06-13T19:00:00Z", "type": "string" }, "vehicleIds": { "description": "A filter on the data based on this comma-separated list of vehicle IDs and external IDs. The number of vehicles requested per job shouldn't exceed 5000. Example: `vehicleIds: '1234,5678,samsara.vin:1HGBH41JXMN109186'`", "example": "1234,5678,samsara.vin:1HGBH41JXMN109186", "type": "string" }, "vehicleParentTagIds": { "description": " A filter on the data based on this comma-separated list of vehicle parent tag IDs. The number of vehicles requested per job shouldn't exceed 5000. Example: `vehicleParentTagIds: '1234,5678'`", "example": "1234,5678", "type": "string" }, "vehicleTagIds": { "description": " A filter on the data based on this comma-separated list of vehicle tag IDs. The number of vehicles requested per job shouldn't exceed 5000. Example: `vehicleTagIds: '1234,5678'`", "example": "1234,5678", "type": "string" } }, "required": [ "endHour", "startHour" ], "type": "object" }, "IFTACreateIftaDetailJobResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/IftaDetailJobResponseBody" } }, "required": [ "data" ], "type": "object" }, "IFTACreateIftaDetailJobServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTACreateIftaDetailJobTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTACreateIftaDetailJobUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/IftaDetailJobResponseBody" } }, "required": [ "data" ], "type": "object" }, "IFTAGetIftaDetailJobServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaDetailJobUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/IftaJurisdictionReportDataObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaJurisdictionReportsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/IftaVehicleReportDataObjectResponseBody" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "IFTAGetIftaVehicleReportsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IFTAGetIftaVehicleReportsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdleTimeDurationMs": { "description": "Time spent idling in milliseconds.", "type": "number" }, "IdlingReportEventAddressResponseBody": { "description": "Address where the idling event took place.", "properties": { "formatted": { "description": "The formatted address of the idling location.", "example": "123 Main Street Atlanta, GA 30307", "type": "string" }, "latitude": { "description": "The latitude of the idling location.", "example": 34.654567, "format": "double", "type": "number" }, "longitude": { "description": "The longitude of the idling location.", "example": 34.654567, "format": "double", "type": "number" } }, "required": [ "formatted", "latitude", "longitude" ], "type": "object" }, "IdlingReportEventResponseBody": { "description": "A summary of the idling event.", "properties": { "address": { "$ref": "#/components/schemas/IdlingReportEventAddressResponseBody" }, "durationMs": { "description": "The duration of this idling event in milliseconds.", "example": 860000, "format": "int64", "type": "integer" }, "endTime": { "description": "The end time of this idling event in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "fuelConsumptionMl": { "description": "The amount of fuel consumed in milliliters during this idling event.", "example": 2500, "format": "double", "type": "number" }, "isPtoActive": { "description": "Whether or not power take-off was active during this idling event.", "example": false, "type": "boolean" }, "startTime": { "description": "The start time of this idling event in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/GoaVehicleTinyResponseResponseBody" } }, "required": [ "address", "durationMs", "endTime", "fuelConsumptionMl", "isPtoActive", "startTime", "vehicle" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsResponseBody": { "properties": { "data": { "description": "Multiple idling events.", "items": { "$ref": "#/components/schemas/IdlingReportEventResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" }, "requestEndTime": { "description": "The requested end time in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "requestStartTime": { "description": "The requested start time in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "required": [ "data", "pagination", "requestEndTime", "requestStartTime" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IdlingReportsGetVehicleIdlingReportsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IftaDetailJobArgsResponseBody": { "description": "The arguments used to create this job.", "properties": { "endHour": { "description": "The `endHour` used to create this job.", "example": "2019-06-13T19:00:00Z", "type": "string" }, "startHour": { "description": "The `startHour` used to create this job.", "example": "2019-06-13T19:00:00Z", "type": "string" }, "vehicleIds": { "description": "The vehicleIds used to create this job. Determined by the filter list of `vehicleIds`, `vehicleTagIds`, and `vehicleParentTagIds` parameters (if provided).", "example": [12345678, 56789123], "items": { "description": "Vehicle ID element of array.", "example": 3.4922864110205286e+18, "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "endHour", "startHour", "vehicleIds" ], "type": "object" }, "IftaDetailJobOutputResponseBody": { "description": " The file outputs produced by a successfully completed job.", "properties": { "createdAtTime": { "description": " When this file was created.", "example": "2019-06-13T19:00:00Z", "type": "string" }, "downloadUrl": { "description": "A url to download the generated file. The contents will be gzipped. This url has an expiration and will no longer be valid after expiration.", "example": "https://s3.download-url.com", "type": "string" }, "downloadUrlExpirationTime": { "description": " The expiration time of this file's download url. Requesting this job again by ID will refresh the download urls, if expired.", "example": "2019-06-13T19:00:00Z", "type": "string" }, "name": { "description": "The name of this file.", "example": "output-001.csv.gz", "type": "string" }, "recordCount": { "description": "The number of records in this file.", "example": 830907839246707300, "format": "int64", "type": "integer" } }, "required": [ "createdAtTime", "downloadUrl", "downloadUrlExpirationTime", "name", "recordCount" ], "type": "object" }, "IftaDetailJobResponseBody": { "description": " A job representing the async generation of IFTA mileage segments. The job should be polled until the state is terminal.", "properties": { "args": { "$ref": "#/components/schemas/IftaDetailJobArgsResponseBody" }, "completedAtTime": { "description": " The time this job completed successfully.", "example": "2019-06-13T19:00:00Z", "type": "string" }, "details": { "description": "A message containing additional details about the job, if available.", "example": "Try limiting the number of vehicles requested per job to reduce the processing duration.", "type": "string" }, "failedAtTime": { "description": " The time this job failed.", "example": "2019-06-13T19:00:00Z", "type": "string" }, "files": { "description": "A list of files generated by this job. This field will be omitted when the job status is \"Failed\" or no data exists with the provided job arguments. Read about the file structure [here](https://developers.samsara.com/docs/ifta-detail-csv).", "items": { "$ref": "#/components/schemas/IftaDetailJobOutputResponseBody" }, "type": "array" }, "jobId": { "description": " The ID used to retrieve this job.", "example": "8cabba84-bef4-4951-8cd2-78ce898fd8e6", "type": "string" }, "jobStatus": { "description": " The status of this job. `jobStatus` can be one of Requested, Processing, Completed, or Failed. Valid values: `Requested`, `Processing`, `Completed`, `Failed`", "enum": [ "Requested", "Processing", "Completed", "Failed" ], "example": "Processing", "type": "string" }, "requestedAtTime": { "description": " The time this job was requested for creation.", "example": "2019-06-13T19:00:00Z", "type": "string" }, "startedAtTime": { "description": " The time this job started processing.", "example": "2019-06-13T19:00:00Z", "type": "string" } }, "required": [ "args", "jobId", "jobStatus", "requestedAtTime" ], "type": "object" }, "IftaJurisdictionReportDataObjectResponseBody": { "description": "Dictionary containing summarized jurisdiction report data.", "properties": { "jurisdictionReports": { "description": "List of summarized jurisdiction reports.", "items": { "$ref": "#/components/schemas/IftaJurisdictionSummaryObjectResponseBody" }, "type": "array" }, "month": { "description": "The specified month duration for this IFTA report.", "example": "January", "type": "string" }, "quarter": { "description": "The specified quarter duration for this IFTA report.", "example": "Q4", "type": "string" }, "troubleshooting": { "$ref": "#/components/schemas/IftaReportTroubleshootingObjectResponseBody" }, "year": { "description": "The specified year for this IFTA report.", "example": 2021, "format": "int64", "type": "integer" } }, "required": [ "jurisdictionReports", "year" ], "type": "object" }, "IftaJurisdictionSummaryObjectResponseBody": { "description": "A summary of this jurisdiction's IFTA data.", "properties": { "jurisdiction": { "description": "Jurisdiction code.", "example": "GA", "type": "string" }, "taxPaidLiters": { "description": "Liters purchased for all qualified vehicles.", "example": 25.5, "format": "double", "type": "number" }, "taxableMeters": { "description": "Distance in meters traveled on public roads in an IFTA jurisdiction.", "example": 2350, "format": "double", "type": "number" }, "totalMeters": { "description": "Total meters driven in this jurisdiction, taxable and non-taxable.", "example": 2350, "format": "double", "type": "number" } }, "required": [ "jurisdiction", "taxableMeters", "totalMeters" ], "type": "object" }, "IftaReportTroubleshootingObjectResponseBody": { "description": "IFTA report troubleshooting information.", "properties": { "noPurchasesFound": { "description": "Whether or not fuel purchases were found for this report.", "example": false, "type": "boolean" }, "unassignedFuelTypePurchases": { "description": "The number of fuel purchases without a fuel type assigned. Fuel purchases are used to calculate tax paid gallons.", "example": 200, "format": "int64", "type": "integer" }, "unassignedFuelTypeVehicles": { "description": "The number of vehicles without a fuel type assigned. Vehicles without an assigned fuel type may affect total mileage.", "example": 2500, "format": "int64", "type": "integer" }, "unassignedVehiclePurchases": { "description": "Purchases without an assigned fuel type may affect tax-paid gallons and fleet mpg.", "example": 2500, "format": "int64", "type": "integer" } }, "required": [ "noPurchasesFound", "unassignedFuelTypePurchases", "unassignedFuelTypeVehicles", "unassignedVehiclePurchases" ], "type": "object" }, "IftaVehicleReportDataObjectResponseBody": { "description": "Dictionary containing summarized vehicle report data.", "properties": { "month": { "description": "The specified month duration for this IFTA report.", "example": "January", "type": "string" }, "quarter": { "description": "The specified quarter duration for this IFTA report.", "example": "Q4", "type": "string" }, "troubleshooting": { "$ref": "#/components/schemas/IftaReportTroubleshootingObjectResponseBody" }, "vehicleReports": { "description": "List of summarized vehicle reports.", "items": { "$ref": "#/components/schemas/IftaVehicleReportObjectResponseBody" }, "type": "array" }, "year": { "description": "The specified year for this IFTA report.", "example": 2021, "format": "int64", "type": "integer" } }, "required": [ "vehicleReports", "year" ], "type": "object" }, "IftaVehicleReportObjectResponseBody": { "description": "A summary of this vehicle's IFTA data.", "properties": { "jurisdictions": { "description": "List of jurisdiction summaries.", "items": { "$ref": "#/components/schemas/IftaJurisdictionSummaryObjectResponseBody" }, "type": "array" }, "vehicle": { "$ref": "#/components/schemas/GoaVehicleTinyResponseResponseBody" } }, "required": [ "jurisdictions", "vehicle" ], "type": "object" }, "InAppNotificationOptionsObjectRequestBody": { "description": "Options for in-app notifications", "properties": { "canDictateAlertTitle": { "default": false, "description": "Whether the alert will dictate the title of the alert. Both canDictateAlertTitle and canPlayAlertSound should be enabled or disabled together.", "example": false, "type": "boolean" }, "canPlayAlertSound": { "default": false, "description": "Whether the alert will play a sound. Both canDictateAlertTitle and canPlayAlertSound should be enabled or disabled together.", "example": false, "type": "boolean" }, "customText": { "description": "Custom text to display in the notification (320 character max).", "example": "Custom text", "maxLength": 320, "type": "string" }, "isEnabled": { "default": true, "description": "Whether in-app notifications are enabled.", "example": true, "type": "boolean" } }, "required": [ "isEnabled" ], "type": "object" }, "InAppNotificationOptionsObjectResponseBody": { "description": "Options for in-app notifications", "properties": { "canDictateAlertTitle": { "default": false, "description": "Whether the alert will dictate the title of the alert. Both canDictateAlertTitle and canPlayAlertSound should be enabled or disabled together.", "example": false, "type": "boolean" }, "canPlayAlertSound": { "default": false, "description": "Whether the alert will play a sound. Both canDictateAlertTitle and canPlayAlertSound should be enabled or disabled together.", "example": false, "type": "boolean" }, "customText": { "description": "Custom text to display in the notification (320 character max).", "example": "Custom text", "maxLength": 320, "type": "string" }, "isEnabled": { "default": true, "description": "Whether in-app notifications are enabled.", "example": true, "type": "boolean" } }, "required": [ "isEnabled" ], "type": "object" }, "InactivityResponseBody": { "description": "Details specific to Inactivity.", "properties": { "cameraStream": { "$ref": "#/components/schemas/alertObjectOnvifCameraStreamResponseBody" } }, "type": "object" }, "InattentiveDrivingDetectionAlertSettingsObjectResponseBody": { "description": "Enables AI detection of inattentive driving events.", "properties": { "hasInCabAudioAlertsEnabled": { "description": "Indicates whether in-cab audio alerts for inattentive driving are turned on.", "example": true, "type": "boolean" }, "isEnabled": { "description": "Indicates whether AI event detection for inattentive driving is turned on.", "example": true, "type": "boolean" }, "severity": { "description": "Severity of inattentive driving events. Options include low (alerts for all events), medium (alerts for medium and high severity events), and high (alerts for high severity events only). Valid values: `low`, `medium`, `high`", "enum": [ "low", "medium", "high" ], "example": "low", "type": "string" }, "speedingThresholdMph": { "description": "Alert when speed is over this many miles per hour.", "example": 10, "format": "double", "type": "number" } }, "type": "object" }, "InsideGeofenceDataResponseBody": { "description": "Details specific to Inside Geofence.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "InsideGeofenceTriggerDetailsObjectRequestBody": { "description": "Details specific to Inside Geofence", "properties": { "location": { "$ref": "#/components/schemas/LocationObjectRequestBody" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "location", "minDurationMilliseconds" ], "type": "object" }, "InsideGeofenceTriggerDetailsObjectResponseBody": { "description": "Details specific to Inside Geofence", "properties": { "location": { "$ref": "#/components/schemas/LocationObjectResponseBody" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "location", "minDurationMilliseconds" ], "type": "object" }, "IssueCreatedResponseBody": { "description": "Details specific to Issue Created.", "properties": { "issue": { "$ref": "#/components/schemas/IssueResponseObjectResponseBody" } }, "required": [ "issue" ], "type": "object" }, "IssueResponseObjectResponseBody": { "description": "Issue response object.", "properties": { "asset": { "$ref": "#/components/schemas/FormsAssetObjectResponseBody" }, "assignedTo": { "$ref": "#/components/schemas/FormsPolymorphicUserObjectResponseBody" }, "createdAtTime": { "description": "Creation time of the issue. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "description": { "description": "Description of the issue. Included if the issue was given a description.", "example": "Oil spill in left corner of SF1", "type": "string" }, "dueDate": { "description": "Due date of the issue. UTC timestamp in RFC 3339 format. Included if the issue was assigned a due date.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the issue.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "issueSource": { "$ref": "#/components/schemas/IssueSourceObjectResponseBody" }, "mediaList": { "description": "List of media objects for the issue. Included if the issue has media.", "items": { "$ref": "#/components/schemas/FormsMediaRecordObjectResponseBody" }, "type": "array" }, "priority": { "description": "Priority of the issue. Included if the issue was assigned a priority. Valid values: `low`, `medium`, `high`", "enum": [ "low", "medium", "high" ], "example": "high", "type": "string" }, "status": { "description": "Status of the issue. Valid values: `open`, `inProgress`, `resolved`, `dismissed`", "enum": [ "open", "inProgress", "resolved", "dismissed" ], "example": "open", "type": "string" }, "submittedAtTime": { "description": "Submission time of the issue. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "submittedBy": { "$ref": "#/components/schemas/FormsPolymorphicUserObjectResponseBody" }, "title": { "description": "Title of the issue.", "example": "Oil spill", "type": "string" }, "updatedAtTime": { "description": "Update time of the issue. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "createdAtTime", "id", "issueSource", "status", "submittedAtTime", "submittedBy", "title", "updatedAtTime" ], "type": "object" }, "IssueSourceObjectResponseBody": { "description": "Contains information about where an issue came from.", "properties": { "id": { "description": "ID of the issue's source object. The format depends on the 'type'. Included if 'type' is not 'ad-hoc'.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "type": { "description": "The type of issue source. Valid values: `form`, `ad-hoc`", "enum": [ "form", "ad-hoc" ], "example": "form", "type": "string" } }, "required": [ "type" ], "type": "object" }, "IssuesGetIssuesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesResponseBody": { "properties": { "data": { "description": "List of issues.", "items": { "$ref": "#/components/schemas/IssueResponseObjectResponseBody" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "IssuesGetIssuesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamResponseBody": { "properties": { "data": { "description": "List of issues.", "items": { "$ref": "#/components/schemas/IssueResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "IssuesGetIssuesStreamServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesStreamUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesGetIssuesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueRequestBody": { "description": "Issue fields to update.", "properties": { "assignedTo": { "$ref": "#/components/schemas/PatchIssueRequestBodyAssignedToRequestBody" }, "dueDate": { "description": "Due date of the issue. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the issue. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the issue.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "status": { "description": "Status of the issue. Valid values: `open`, `inProgress`, `resolved`, `dismissed`", "enum": [ "open", "inProgress", "resolved", "dismissed" ], "example": "open", "type": "string" } }, "required": [ "id" ], "type": "object" }, "IssuesPatchIssueResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/IssueResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "IssuesPatchIssueServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "IssuesPatchIssueUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "J1939D1StatusDataPoint": { "description": "Active J1939D1 statuses of a device.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "List of active statuses.", "items": { "$ref": "#/components/schemas/J1939D1StatusDataPoint_value" }, "type": "array" } }, "type": "object" }, "J1939D1StatusDataPoint_value": { "description": "A single J1939D1 status", "properties": { "amberLampStatus": { "format": "int32", "type": "number" }, "fmi": { "format": "int32", "type": "number" }, "milStatus": { "format": "int32", "type": "number" }, "occuranceCount": { "format": "int32", "type": "number" }, "protectLampStatus": { "format": "int32", "type": "number" }, "redLampStatus": { "format": "int32", "type": "number" }, "spn": { "format": "int32", "type": "number" }, "txId": { "format": "int32", "type": "number" } }, "type": "object" }, "JammingDetectedResponseBody": { "description": "Details specific to Jamming Detected.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "JobResponseObjectResponseBody": { "description": "Job object to be passed back", "properties": { "address": { "$ref": "#/components/schemas/jobLocationResponseObjectResponseBody" }, "createdAt": { "description": "When the job was created", "example": "2019-06-13T19:08:25Z", "type": "string" }, "customerName": { "description": "Customer name for job", "example": "Samsara", "type": "string" }, "endDate": { "description": "End date of job in RFC 3339 format", "example": "2019-06-13T19:08:25Z", "type": "string" }, "fleetDevices": { "description": "fleet devices in this job (cannot have both industrial assets and fleet devices in the same job)", "items": { "$ref": "#/components/schemas/fleetDeviceObjectResponseBody" }, "type": "array" }, "id": { "description": "Job id", "example": "1553", "type": "string" }, "industrialAssets": { "description": "Industrial Assets in this job (cannot have both industrial assets and fleet devices in the same job)", "items": { "$ref": "#/components/schemas/industrialAssetObjectResponseBody" }, "type": "array" }, "modifiedAt": { "description": "When the job was last modified", "example": "2019-06-13T19:08:25Z", "type": "string" }, "name": { "description": "Job name", "example": "My Job Name", "type": "string" }, "notes": { "description": "Notes for the upcoming job", "example": "These are my notes", "maxLength": 2000, "type": "string" }, "ontimeWindowAfterArrivalMs": { "description": "Specifies the time window (in milliseconds) after a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "format": "int64", "type": "integer" }, "ontimeWindowBeforeArrivalMs": { "description": "Specifies the time window (in milliseconds) before a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "format": "int64", "type": "integer" }, "startDate": { "description": "Start date of job in RFC 3339 format", "example": "2019-06-13T19:08:25Z", "type": "string" }, "status": { "description": "The current job status Valid values: `active`, `scheduled`, `completed`", "enum": [ "active", "scheduled", "completed" ], "example": "active", "type": "string" }, "uuid": { "description": "Samsara uuid", "example": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "type": "string" } }, "required": [ "address", "createdAt", "customerName", "endDate", "id", "modifiedAt", "name", "notes", "startDate", "status", "uuid" ], "type": "object" }, "JobsCreateJobBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsCreateJobBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsCreateJobGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsCreateJobInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsCreateJobMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsCreateJobNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsCreateJobNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsCreateJobRequestBody": { "description": "Job object to be created", "properties": { "job": { "$ref": "#/components/schemas/PostJobObjectRequestBody" } }, "required": [ "job" ], "type": "object" }, "JobsCreateJobResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/JobResponseObjectResponseBody" }, "id": { "description": "The job id of the failed request", "example": "1553", "type": "string" }, "uuid": { "description": "The uuid of the failed request", "example": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "type": "string" } }, "required": [ "data" ], "type": "object" }, "JobsCreateJobServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsCreateJobTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsCreateJobUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobResponseBody": { "properties": { "id": { "description": "The job id of the failed request", "example": "1553", "type": "string" }, "uuid": { "description": "The uuid of the failed request", "example": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "type": "string" } }, "type": "object" }, "JobsDeleteJobServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsDeleteJobUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsResponseBody": { "properties": { "data": { "description": "List of Job Objects", "items": { "$ref": "#/components/schemas/JobResponseObjectResponseBody" }, "type": "array" }, "id": { "description": "The job id of the failed request", "example": "1553", "type": "string" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" }, "uuid": { "description": "The uuid of the failed request", "example": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "type": "string" } }, "required": [ "data", "pagination" ], "type": "object" }, "JobsGetJobsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsGetJobsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobRequestBody": { "description": "Job object with fields to update. If a field is not provided, it will not be updated", "properties": { "job": { "$ref": "#/components/schemas/PatchJobObjectRequestBody" }, "keepHistory": { "default": true, "description": "Defaults to true if user does not want to overwrite entire history for an active job (irrelevant for scheduled/completed jobs)", "example": true, "type": "boolean" } }, "required": [ "job" ], "type": "object" }, "JobsPatchJobResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/JobResponseObjectResponseBody" }, "id": { "description": "The job id of the failed request", "example": "1553", "type": "string" }, "uuid": { "description": "The uuid of the failed request", "example": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "type": "string" } }, "required": [ "data" ], "type": "object" }, "JobsPatchJobServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "JobsPatchJobUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LastKnownLocationResponseResponseBody": { "description": "The most recent location information for the device.", "properties": { "id": { "description": "The unique ID of the address.", "example": 12345, "format": "int64", "type": "integer" }, "latitude": { "description": "Latitude of a location.", "example": 12333122.3, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of a location.", "example": 1233331.4, "format": "double", "type": "number" } }, "type": "object" }, "ListAddressesResponse": { "description": "A list of Addresses and pagination information.", "properties": { "data": { "description": "A list of Addresses.", "items": { "$ref": "#/components/schemas/Address" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "ListCarrierProposedAssignmentResponse": { "description": "A list of carrier-proposed assignments and pagination information.", "properties": { "data": { "description": "A list of carrier-proposed assignments", "items": { "$ref": "#/components/schemas/CarrierProposedAssignment" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "ListContactsResponse": { "description": "A list of contacts.", "properties": { "data": { "items": { "$ref": "#/components/schemas/Contact" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "ListDriversResponse": { "description": "A list of drivers.", "properties": { "data": { "items": { "$ref": "#/components/schemas/Driver" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "ListIndustrialAssetsResponse": { "properties": { "data": { "items": { "$ref": "#/components/schemas/AssetResponse" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "ListTagsResponse": { "description": "A list of tags.", "properties": { "data": { "items": { "$ref": "#/components/schemas/Tag" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "ListUploadedMediaObjectResponseBody": { "properties": { "media": { "description": "List of media retrieval objects.", "items": { "$ref": "#/components/schemas/UploadedMediaObjectResponseBody" }, "type": "array" } }, "required": [ "media" ], "type": "object" }, "ListUserRolesResponse": { "description": "A list of user roles.", "properties": { "data": { "description": "A list of user roles", "items": { "$ref": "#/components/schemas/UserRole" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "ListUsersResponse": { "description": "A list of users.", "properties": { "data": { "description": "A list of users.", "items": { "$ref": "#/components/schemas/User" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "ListVehiclesResponse": { "description": "Response for retrieving a list of vehicles.", "properties": { "data": { "items": { "$ref": "#/components/schemas/Vehicle" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "LiveSharingLinkFullResponseObjectResponseBody": { "description": "Live Sharing Link object", "properties": { "assetsLocationLinkConfig": { "$ref": "#/components/schemas/AssetsLocationLinkConfigObjectResponseBody" }, "assetsNearLocationLinkConfig": { "$ref": "#/components/schemas/AssetsNearLocationLinkConfigObjectResponseBody" }, "assetsOnRouteLinkConfig": { "$ref": "#/components/schemas/AssetsOnRouteLinkConfigObjectResponseBody" }, "description": { "description": "Description for the Live Sharing Link (not applicable for 'assetsOnRoute' type).", "example": "Sample description", "maxLength": 255, "type": "string" }, "expiresAtTime": { "description": "Date that this link expires, in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "id": { "description": "Unique identifier for the Live Sharing Link.", "example": "leesdwqjx42dkvp86so", "type": "string" }, "liveSharingUrl": { "description": "The shareable URL of the vehicle's location.", "example": "https://cloud.samsara.com/o/123456/fleet/viewer/address/7hf4lnu455wep22rtun", "type": "string" }, "name": { "description": "Name of the Live Sharing Link.", "example": "Example Live Sharing Link name", "maxLength": 255, "type": "string" }, "type": { "description": "Type of the Live Sharing Link. Valid values: `assetsLocation`, `assetsNearLocation`, `assetsOnRoute`", "enum": [ "assetsLocation", "assetsNearLocation", "assetsOnRoute" ], "example": "assetsLocation", "type": "string" } }, "required": [ "id", "liveSharingUrl", "name", "type" ], "type": "object" }, "LiveSharingLinkResponseObjectResponseBody": { "description": "Live Sharing Link response object.", "properties": { "expiresAtTime": { "description": "Date that this link expires, in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "liveSharingUrl": { "description": "The shareable URL of the vehicle's location.", "example": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU", "type": "string" }, "name": { "description": "Name of the Live Sharing Link.", "example": "Name", "type": "string" } }, "required": [ "liveSharingUrl", "name" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkRequestBody": { "properties": { "assetsLocationLinkConfig": { "$ref": "#/components/schemas/AssetsLocationLinkConfigObject" }, "assetsNearLocationLinkConfig": { "$ref": "#/components/schemas/AssetsNearLocationLinkConfigObject" }, "assetsOnRouteLinkConfig": { "$ref": "#/components/schemas/AssetsOnRouteLinkConfigObject" }, "description": { "description": "Description for the Live Sharing Link (not applicable for 'assetsOnRoute' type).", "example": "Sample description", "maxLength": 255, "type": "string" }, "expiresAtTime": { "description": "Date that this link expires in RFC 3339 format. Can't be set in the past. If not provided then link will never expire.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "name": { "description": "Name of the Live Sharing Link.", "example": "Example Live Sharing Link name", "maxLength": 255, "type": "string" }, "type": { "description": "Type of the Live Sharing Link. This field specifies which one of '\u003Ctype\u003ELinkConfig' objects will be used to configure the sharing link. Valid values: `assetsLocation`, `assetsNearLocation`, `assetsOnRoute`", "enum": [ "assetsLocation", "assetsNearLocation", "assetsOnRoute" ], "example": "assetsLocation", "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/LiveSharingLinkFullResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksCreateLiveSharingLinkUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksDeleteLiveSharingLinkUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksResponseBody": { "properties": { "data": { "items": { "$ref": "#/components/schemas/LiveSharingLinkFullResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksGetLiveSharingLinksUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkRequestBody": { "properties": { "description": { "description": "Description for the Live Sharing Link (not applicable for 'assetsOnRoute' type).", "example": "Sample description", "maxLength": 255, "type": "string" }, "expiresAtTime": { "description": "Date that this link expires in RFC 3339 format. Can't be set in the past. If not provided then link will never expire.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "name": { "description": "Name of the Live Sharing Link.", "example": "Example Live Sharing Link name", "maxLength": 255, "type": "string" } }, "required": [ "name" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/LiveSharingLinkFullResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LiveSharingLinksUpdateLiveSharingLinkUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedResponseBody": { "properties": { "data": { "description": "List of location and speed objects.", "items": { "$ref": "#/components/schemas/LocationAndSpeedResponseResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationWithTokensResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedGetLocationAndSpeedUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "LocationAndSpeedResponseResponseBody": { "description": "Full location and speed objects.", "properties": { "asset": { "$ref": "#/components/schemas/AssetResponseResponseBody" }, "happenedAtTime": { "description": "UTC timestamp in RFC 3339 format of the event.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "location": { "$ref": "#/components/schemas/LocationResponseResponseBody" }, "speed": { "$ref": "#/components/schemas/SpeedResponseResponseBody" } }, "required": [ "asset", "happenedAtTime", "location" ], "type": "object" }, "LocationDataPoint": { "description": "A single location data point of a data input.", "properties": { "gpsLocation": { "$ref": "#/components/schemas/LocationDataPoint_gpsLocation" }, "time": { "$ref": "#/components/schemas/time" } }, "type": "object" }, "LocationDataPoint_gpsLocation": { "description": "GPS location information of the data input's datapoint.", "properties": { "formattedAddress": { "description": "Formatted address of the location", "example": "350 Rhode Island St, San Francisco CA, 94103", "format": "string", "type": "string" }, "gpsMetersPerSecond": { "description": "Speed of GPS (meters per second)", "example": 35.5, "format": "double", "type": "number" }, "headingDegrees": { "description": "Heading degrees", "example": 91.2, "format": "double", "type": "number" }, "latitude": { "description": "Latitude of the location", "example": 42.44817, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the location", "example": -71.224716, "format": "double", "type": "number" }, "place": { "$ref": "#/components/schemas/LocationDataPoint_gpsLocation_place" } }, "type": "object" }, "LocationDataPoint_gpsLocation_place": { "description": "Address of the location", "properties": { "city": { "description": "City", "example": "San Francisco", "format": "string", "type": "string" }, "houseNumber": { "description": "House number", "example": "350", "format": "string", "type": "string" }, "neighborhood": { "description": "Neighborhood", "example": "Castro", "format": "string", "type": "string" }, "poi": { "description": "POI", "example": "400", "format": "string", "type": "string" }, "postcode": { "description": "Postcode", "example": "94103", "format": "string", "type": "string" }, "state": { "description": "State", "example": "CA", "format": "string", "type": "string" }, "street": { "description": "Street", "example": "Rhode Island", "format": "string", "type": "string" } }, "type": "object" }, "LocationObjectRequestBody": { "description": "A location. Polygon and Circle is deprecated, but may be set for old Alerts. At least one location must be selected.", "properties": { "addressIds": { "description": "All locations with selected address IDs will trigger.", "example": [ "Ipsam doloremque.", "Quisquam rerum dolorum et unde.", "In culpa voluptas ab.", "Repellendus vel fugit iure." ], "items": { "description": "Id of the address.", "example": "Rerum consectetur ut et.", "type": "string" }, "type": "array" }, "addressTypes": { "description": "All locations with the selected address types will trigger.", "example": [ "yard", "undefined" ], "items": { "description": "Type of the address. Valid values: `agricultureSource`, `alertsOnly`, `industrialSite`, `riskZone`, `shortHaul`, `undefined`, `workforceSite`, `yard`", "enum": [ "agricultureSource", "alertsOnly", "industrialSite", "riskZone", "shortHaul", "undefined", "workforceSite", "yard" ], "example": "shortHaul", "type": "string" }, "type": "array" }, "circle": { "$ref": "#/components/schemas/CircleRequestBody" }, "polygon": { "$ref": "#/components/schemas/PolygonRequestBody" }, "tagIds": { "description": "All locations with selected tag will trigger.", "example": [ "4815", "4815", "4815" ], "items": { "description": "Id of the tag.", "example": "4815", "type": "string" }, "type": "array" } }, "type": "object" }, "LocationObjectResponseBody": { "description": "A location. Polygon and Circle is deprecated, but may be set for old Alerts. At least one location must be selected.", "properties": { "addressIds": { "description": "All locations with selected address IDs will trigger.", "example": [ "Sequi eos sunt.", "Fuga quisquam distinctio nostrum rerum debitis ut.", "Qui sint earum cum nam voluptatum nihil." ], "items": { "description": "Id of the address.", "example": "Eos dolor magni mollitia.", "type": "string" }, "type": "array" }, "addressTypes": { "description": "All locations with the selected address types will trigger.", "example": [ "riskZone", "undefined", "industrialSite", "yard" ], "items": { "description": "Type of the address. Valid values: `agricultureSource`, `alertsOnly`, `industrialSite`, `riskZone`, `shortHaul`, `undefined`, `workforceSite`, `yard`", "enum": [ "agricultureSource", "alertsOnly", "industrialSite", "riskZone", "shortHaul", "undefined", "workforceSite", "yard" ], "example": "undefined", "type": "string" }, "type": "array" }, "circle": { "$ref": "#/components/schemas/CircleResponseBody" }, "polygon": { "$ref": "#/components/schemas/PolygonResponseBody" }, "tagIds": { "description": "All locations with selected tag will trigger.", "example": [ "4815", "4815" ], "items": { "description": "Id of the tag.", "example": "4815", "type": "string" }, "type": "array" } }, "type": "object" }, "LocationResponseBody": { "description": "Equipment location.", "properties": { "Latitude": { "description": "Location latitude.", "example": 12.34, "format": "double", "type": "number" }, "Longitude": { "description": "Location longitude.", "example": 12.34, "format": "double", "type": "number" }, "datetime": { "description": "Date time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "LocationResponseResponseBody": { "description": "Location object.", "properties": { "accuracyMeters": { "description": "Radial accuracy of gps location in meters. This will only return if strong GPS is not available.", "example": 5.801, "format": "double", "type": "number" }, "address": { "$ref": "#/components/schemas/AddressResponseResponseBody" }, "geofence": { "$ref": "#/components/schemas/GeofenceResponseResponseBody" }, "headingDegrees": { "description": "Heading of the asset in degrees. May be 0 if the asset is not moving.", "example": 120, "format": "int64", "type": "integer" }, "latitude": { "description": "Latitude of the location of the asset.", "example": 37.7749, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the location of the asset.", "example": 137.2719, "format": "double", "type": "number" } }, "required": [ "headingDegrees", "latitude", "longitude" ], "type": "object" }, "LocationType": { "description": "The format of the location. This field is required if a location is provided. Valid values: `point`, `address`, `dataInput`.", "enum": [ "point", "address", "dataInput" ], "type": "string" }, "LogMetaDataObjectResponseBody": { "description": "The metadata of the log.", "properties": { "adverseDrivingClaimed": { "description": "Whether the driver has claimed the [Adverse Driving Exemption](https://kb.samsara.com/hc/en-us/articles/360047336792-Adverse-Driving-Exemption) for this HOS day chart.", "example": true, "type": "boolean" }, "bigDayClaimed": { "description": "Whether the driver has claimed the [Big Day Exemption](https://kb.samsara.com/hc/en-us/articles/360057113891-16-Hour-Short-Haul-Exemption-Big-Day-) for this HOS day chart.", "example": true, "type": "boolean" }, "carrierFormattedAddress": { "description": "The address of the carrier used for this HOS chart.", "example": "1990 Alameda Street, San Francisco, CA 94103", "type": "string" }, "carrierName": { "description": "The name of the carrier used for this HOS chart.", "example": "Carrier Name", "type": "string" }, "carrierUsDotNumber": { "description": "The US DOT number of the carrier used for this HOS chart.", "example": 1234, "format": "int64", "type": "integer" }, "certifiedAtTime": { "description": "The time this log was certified in RFC 3339 format.", "example": "2020-01-01T06:00:00Z", "type": "string" }, "homeTerminalFormattedAddress": { "description": "The address of the Home Terminal used for this HOS chart.", "example": "1990 Alameda Street, San Francisco, CA 94103", "type": "string" }, "homeTerminalName": { "description": "The name of the Home Terminal used for this HOS chart.", "example": "Home Terminal Name", "type": "string" }, "isCertified": { "description": "Whether this HOS day chart was certified by the driver.", "example": false, "type": "boolean" }, "isUsShortHaulActive": { "description": "Whether the driver has the 150 air-mile Short Haul Exemption active for this HOS day chart.", "example": true, "type": "boolean" }, "shippingDocs": { "description": "List of shipping document names associated with the driver for the day. This field maps to Shipping ID in the dashboard.", "example": "Delivery 123, chips and soda", "type": "string" }, "trailerNames": { "description": "List of trailer names associated with the driver for the day. If a trailer was associated with a log through the driver app the trailer name will be the trailer ID.", "example": [ "10293", "Trailer ID 1" ], "items": { "example": "Quo assumenda a atque aut.", "type": "string" }, "type": "array" }, "vehicles": { "description": "List of vehicles associated with the driver for the day.", "items": { "$ref": "#/components/schemas/VehicleResponseResponseBody" }, "type": "array" } }, "type": "object" }, "MediaObjectResponseBody": { "properties": { "availableAtTime": { "description": "Timestamp, in RFC 3339 format, at which the media item was made available. Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00", "example": "2019-11-11T14:00:12-04:00", "type": "string" }, "endTime": { "description": " An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "input": { "description": "Input type for this media. Examples: dashcamDriverFacing Valid values: `dashcamDriverFacing`, `dashcamRoadFacing`", "enum": [ "dashcamDriverFacing", "dashcamRoadFacing" ], "example": "dashcamDriverFacing", "type": "string" }, "mediaType": { "description": "Type of media. Examples: IMAGE, VIDEO Valid values: `IMAGE`, `VIDEO`", "enum": [ "IMAGE", "VIDEO" ], "example": "IMAGE", "type": "string" }, "startTime": { "description": " A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "status": { "description": "Status of the media. Examples: invalid, pending, requested, available. Valid values: `available`, `invalid`, `pending`, `requested`", "enum": [ "available", "invalid", "pending", "requested" ], "example": "available", "type": "string" }, "urlInfo": { "$ref": "#/components/schemas/UrlInfoObjectResponseBody" }, "vehicleId": { "description": "Vehicle ID for which this media was captured. Examples: 1234", "example": "1234", "type": "string" } }, "required": [ "endTime", "input", "mediaType", "startTime", "status", "vehicleId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/GetMediaRetrievalObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalGetMediaRetrievalUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/ListUploadedMediaObjectResponseBody" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "MediaRetrievalListUploadedMediaServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalListUploadedMediaUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalRequestBody": { "properties": { "endTime": { "description": "An end time in RFC 3339 format. If endTime is the same as startTime, an image will be captured at startTime. Must be equal to or after startTime and no more than 60 seconds after startTime (Examples: 2019-06-13T19:08:55Z, 2019-06-13T19:08:55.455Z, OR 2015-09-15T14:00:42-04:00).", "example": "2019-06-13T19:08:55Z", "type": "string" }, "inputs": { "description": "A list of desired camera inputs for which to capture media. Only media with valid inputs (e.g. device has that input stream and device was recording at the time) will be uploaded. An empty list is invalid.", "example": [ "dashcamRoadFacing", "dashcamRoadFacing", "dashcamRoadFacing" ], "items": { "description": "input Valid values: `dashcamRoadFacing`, `dashcamDriverFacing`, `analog`", "enum": [ "dashcamRoadFacing", "dashcamDriverFacing", "analog" ], "example": "dashcamRoadFacing", "type": "string" }, "type": "array" }, "mediaType": { "description": "The desired media type. If a video is requested, endTime must be after startTime. If an image is requested, endTime must be the same as startTime. Must be one of: IMAGE, VIDEO_HIGH_RES. Examples: IMAGE, VIDEO_HIGH_RES. Valid values: `IMAGE`, `VIDEO_HIGH_RES`", "enum": [ "IMAGE", "VIDEO_HIGH_RES" ], "example": "VIDEO_HIGH_RES", "type": "string" }, "startTime": { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "vehicleId": { "description": "Vehicle ID for which to initiate media capture. Examples: 1234", "example": "1234", "type": "string" } }, "required": [ "endTime", "inputs", "mediaType", "startTime", "vehicleId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PostMediaRetrievalObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MediaRetrievalPostMediaRetrievalUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "MinimalRouteAuditLogsResponseBody": { "description": "A single route. Only the fields that have changed are present in the response. All other fields, including the route id, will not be present in the response. For now, only routeStops are included since only Route Tracking updates are supported.", "properties": { "stops": { "description": "The route stops in the route. Only stops that have been updated will be included in the response.", "items": { "$ref": "#/components/schemas/MinimalRouteStopAuditLogsResponseBody" }, "type": "array" } }, "type": "object" }, "MinimalRouteStopAuditLogsResponseBody": { "description": "A single route stop for a route.", "properties": { "actualArrivalTime": { "description": "Actual arrival time, if it exists, for the route stop in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "actualDepartureTime": { "description": "Actual departure time, if it exists, for the route stop in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "enRouteTime": { "description": "The time the stop became en-route, in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "eta": { "description": "Estimated time of arrival, if this stop is currently en-route, in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "Unique identifier for the route stop.", "example": "141414", "type": "string" }, "liveSharingUrl": { "description": "The shareable url of the stop's current status.", "example": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token", "type": "string" }, "scheduledArrivalTime": { "description": "Scheduled arrival time, if it exists, for the stop in RFC 3339 format. If it does not exist, and this field was changed in the update, it will be an empty string.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "scheduledDepartureTime": { "description": "Scheduled departure time, if it exists, for the stop in RFC 3339 format. If it does not exist, and this field was changed in the update, it will be an empty string.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "skippedTime": { "description": "Skipped time, if it exists, for the route stop in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "state": { "description": "The current state of the route stop. Valid values: `unassigned`, `scheduled`, `en route`, `skipped`, `arrived`, `departed`", "enum": [ "unassigned", "scheduled", "en route", "skipped", "arrived", "departed" ], "example": "scheduled", "type": "string" } }, "required": [ "id" ], "type": "object" }, "MinimalRouteStopResponseBody": { "description": "A single route stop for a route.", "properties": { "actualArrivalTime": { "description": "Actual arrival time, if it exists, for the route stop in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "actualDepartureTime": { "description": "Actual departure time, if it exists, for the route stop in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "enRouteTime": { "description": "The time the stop became en-route, in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "eta": { "description": "Estimated time of arrival, if this stop is currently en-route, in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "Unique identifier for the route stop.", "example": "141414", "type": "string" }, "liveSharingUrl": { "description": "The shareable url of the stop's current status.", "example": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token", "type": "string" }, "skippedTime": { "description": "Skipped time, if it exists, for the route stop in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "state": { "description": "The current state of the route stop. Valid values: `unassigned`, `scheduled`, `en route`, `skipped`, `arrived`, `departed`", "enum": [ "unassigned", "scheduled", "en route", "skipped", "arrived", "departed" ], "example": "scheduled", "type": "string" } }, "required": [ "id", "state" ], "type": "object" }, "MobileUsageDetectionAlertSettingsObjectResponseBody": { "description": "Enables AI detection of mobile usage events.", "properties": { "hasInCabAudioAlertsEnabled": { "description": "Indicates whether in-cab audio alerts for mobile usage are turned on.", "example": true, "type": "boolean" }, "isEnabled": { "description": "Indicates whether AI event detection for mobile usage is turned on.", "example": true, "type": "boolean" }, "speedingThresholdMph": { "description": "Alert when speed is over this many miles per hour.", "example": 5, "format": "double", "type": "number" } }, "type": "object" }, "MotionDetectedResponseBody": { "description": "Details specific to Motion Detected.", "properties": { "cameraStream": { "$ref": "#/components/schemas/alertObjectOnvifCameraStreamResponseBody" } }, "type": "object" }, "NumberDataPoint": { "description": "A single numeric data point of a data input.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Numeric value of the data point.", "example": 1992.0506, "format": "double", "type": "number" } }, "type": "object" }, "OperationalSettingsObjectRequestBody": { "description": "Settings on when the alert should be operational.", "properties": { "timeRangeType": { "description": "The type of time ranges. Valid values: `activeBetween`, `inactiveBetween`", "enum": [ "activeBetween", "inactiveBetween" ], "example": "activeBetween", "type": "string" }, "timeRanges": { "description": "The time ranges this alert applies to.", "items": { "$ref": "#/components/schemas/TimeRangeObjectRequestBody" }, "type": "array" } }, "required": [ "timeRangeType", "timeRanges" ], "type": "object" }, "OperationalSettingsObjectResponseBody": { "description": "Settings on when the alert should be operational.", "properties": { "timeRangeType": { "description": "The type of time ranges. Valid values: `activeBetween`, `inactiveBetween`", "enum": [ "activeBetween", "inactiveBetween" ], "example": "activeBetween", "type": "string" }, "timeRanges": { "description": "The time ranges this alert applies to.", "items": { "$ref": "#/components/schemas/TimeRangeObjectResponseBody" }, "type": "array" } }, "required": [ "timeRangeType", "timeRanges" ], "type": "object" }, "OrganizationInfo": { "description": "Information about your organization.", "properties": { "carrierSettings": { "$ref": "#/components/schemas/OrganizationInfo_carrierSettings" }, "id": { "description": "ID of the organization.", "example": "123", "type": "string" }, "name": { "description": "Name of organization.", "example": "Charlie's Dining Services", "type": "string" } }, "type": "object" }, "OrganizationInfoResponse": { "description": "Information about an organization.", "properties": { "data": { "$ref": "#/components/schemas/OrganizationInfo" } }, "type": "object" }, "OrganizationInfo_carrierSettings": { "description": "Carrier for a given organization.", "properties": { "carrierName": { "description": "Carrier for a given organization.", "example": "Acme Inc.", "maxLength": 255, "type": "string" }, "dotNumber": { "description": "Carrier US DOT Number for the organization.", "example": 98231, "format": "int64", "type": "integer" }, "mainOfficeAddress": { "description": "Main office address for a given organization.", "example": "1234 Pear St., Scranton, PA 62814", "maxLength": 255, "type": "string" } }, "type": "object" }, "OutOfRouteDetailsObjectRequestBody": { "description": "Details specific to Out Of Route", "properties": { "maxOffRouteMeters": { "description": "The minimum distance in meters a vehicle has to be from its active route path to be considered out of its route.", "example": 100, "format": "int64", "type": "integer" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "maxOffRouteMeters", "minDurationMilliseconds" ], "type": "object" }, "OutOfRouteDetailsObjectResponseBody": { "description": "Details specific to Out Of Route", "properties": { "maxOffRouteMeters": { "description": "The minimum distance in meters a vehicle has to be from its active route path to be considered out of its route.", "example": 100, "format": "int64", "type": "integer" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "maxOffRouteMeters", "minDurationMilliseconds" ], "type": "object" }, "OutOfRouteResponseBody": { "description": "Details specific to Out Of Route.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "OutsideGeofenceDataResponseBody": { "description": "Details specific to Outside Geofence.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "OutsideGeofenceTriggerDetailsObjectRequestBody": { "description": "Details specific to Outside Geofence", "properties": { "location": { "$ref": "#/components/schemas/LocationObjectRequestBody" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "location", "minDurationMilliseconds" ], "type": "object" }, "OutsideGeofenceTriggerDetailsObjectResponseBody": { "description": "Details specific to Outside Geofence", "properties": { "location": { "$ref": "#/components/schemas/LocationObjectResponseBody" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "location", "minDurationMilliseconds" ], "type": "object" }, "OverSpeedMs": { "description": "Driving time spent over the efficient speed threshold in milliseconds.", "type": "number" }, "PanicButtonDetailsObjectRequestBody": { "description": "Details specific to Panic Button", "properties": { "isFilteringOutPowerLoss": { "description": "If true, only receive alerts when the panic button is pressed, otherwise receive alerts when the panic button is pressed or looses connection.", "example": true, "type": "boolean" } }, "required": [ "isFilteringOutPowerLoss" ], "type": "object" }, "PanicButtonDetailsObjectResponseBody": { "description": "Details specific to Panic Button", "properties": { "isFilteringOutPowerLoss": { "description": "If true, only receive alerts when the panic button is pressed, otherwise receive alerts when the panic button is pressed or looses connection.", "example": true, "type": "boolean" } }, "required": [ "isFilteringOutPowerLoss" ], "type": "object" }, "PanicButtonResponseBody": { "description": "Details specific to Panic Button.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "ParentId": { "description": "The id of the parent asset that the asset belongs to.", "example": "123abcde-4567-8910-1112-fghi1314jklm", "type": "string" }, "ParentTag": { "description": "If this tag is part a hierarchical tag tree, this is the parent tag, otherwise this will be omitted.", "properties": { "id": { "$ref": "#/components/schemas/TaggedObjectId" }, "name": { "$ref": "#/components/schemas/ParentTagName" } }, "required": [ "id" ], "type": "object" }, "ParentTagId": { "description": "If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.", "example": "4815", "type": "string" }, "ParentTagName": { "description": "The tag name.", "example": "US West Vehicles", "type": "string" }, "PatchAssetDataOutputsSingleResponseResponseBody": { "description": "A response that corresponds to an element in the original request body.", "properties": { "errorMessage": { "description": "If the request failed, this displays the error message.", "example": "Failed to write to Device: GFRV-43N-VGX", "type": "string" }, "id": { "description": "The data output ID.", "example": "8a9371af-82d1-4158-bf91-4ecc8d3a114c", "type": "string" }, "statusCode": { "description": "The status code of the request. 200 indicates the request succeeded for this data output. 500 indicates an internal server error.", "example": 200, "format": "int64", "type": "integer" } }, "required": [ "id", "statusCode" ], "type": "object" }, "PatchDriverTrailerAssignmentsResponseBodyResponseBody": { "description": "Response after successfully updating a Driver Trailer Assignment", "properties": { "createdAtTime": { "description": "Time when the driver trailer assignment was created, in RFC 3339 format", "example": "2019-06-13T19:08:25Z", "type": "string" }, "driverId": { "description": "Samsara ID for the driver that this assignment is for.", "example": "0987", "type": "string" }, "endTime": { "description": "Time when the driver trailer assignment ends, in RFC 3339 format", "example": "2019-06-13T19:08:25Z", "type": "string" }, "id": { "description": "Samsara ID for the assignment.", "example": "08b3aeada5f4ab3010c0b4efa28d2d1890dbf8d48d2d6", "type": "string" }, "startTime": { "description": "Time when the driver trailer assignment starts, in RFC 3339 format", "example": "2019-06-13T19:08:25Z", "type": "string" }, "trailerId": { "description": "Samsara ID of the trailer", "example": "494123", "type": "string" }, "updatedAtTime": { "description": "Time when the driver trailer assignment was last updated, in RFC 3339 format", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "required": [ "driverId", "endTime", "id", "startTime", "trailerId" ], "type": "object" }, "PatchDriverVehicleAssignmentsV2RequestBodyMetadataRequestBody": { "description": "Metadata about this driver assignment", "properties": { "sourceName": { "description": "Describes where the external assignment is coming from", "example": "My custom assignment source", "maxLength": 100, "type": "string" } }, "type": "object" }, "PatchDriverVehicleAssignmentsV2ResponseBodyResponseBody": { "description": "Response after successfully updating a Driver Assignment", "properties": { "message": { "description": "A description of the outcome from updating Driver Assignment information", "example": "Driver assignment was successfully updated", "type": "string" } }, "type": "object" }, "PatchIssueRequestBodyAssignedToRequestBody": { "description": "Issue assignee update object", "properties": { "id": { "description": "ID of the issue assignee.", "example": "938172", "type": "string" }, "type": { "description": "Type of the issue assignee. Valid values: `user`", "enum": [ "user" ], "example": "user", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "PatchJobObjectRequestBody": { "description": "Job object with fields to update. If a field is not provided, it will not be updated", "properties": { "address": { "$ref": "#/components/schemas/PatchJobObjectjobLocationRequestObjectRequestBody" }, "customerName": { "description": "Customer name for job", "example": "Samsara", "type": "string" }, "endDate": { "description": "End date of job in RFC 3339 format. Must be greater than or equal to the start date", "example": "2019-06-13T19:08:25Z", "type": "string" }, "fleetDeviceIds": { "description": "Fleet devices to be added to this job (cannot have both industrial assets and fleet devices in the same job)", "example": [1234567, 654321], "items": { "example": 7.465002275927029e+18, "format": "int64", "type": "integer" }, "type": "array" }, "id": { "description": "Job Id", "example": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "type": "string" }, "industrialAssetIds": { "description": "IndustrialAssets to be added to this job (cannot have both industrial assets and fleet devices in the same job)", "example": [ "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "ba84a7e2-9c8d-481f-a248-7cce6b22be9d" ], "items": { "example": "Aspernatur placeat.", "type": "string" }, "type": "array" }, "name": { "description": "Job name", "example": "My Job Name", "type": "string" }, "notes": { "description": "Notes for the upcoming job", "example": "These are my notes", "maxLength": 2000, "type": "string" }, "ontimeWindowAfterArrivalMs": { "description": "Specifies the time window (in milliseconds) after a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "maximum": 259200000, "minimum": 0, "type": "integer" }, "ontimeWindowBeforeArrivalMs": { "description": "Specifies the time window (in milliseconds) before a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "maximum": 259200000, "minimum": 0, "type": "integer" }, "startDate": { "description": "Start date of job in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "type": "object" }, "PatchJobObjectjobLocationRequestObjectRequestBody": { "description": "A location object for the job", "properties": { "address": { "description": "Address of a location", "example": "1990 Alameda st, San Francisco, Ca 94103", "type": "string" }, "latitude": { "description": "Latitude of a location", "example": 37.456345, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of a location", "example": 34.5633749, "format": "double", "type": "number" }, "name": { "description": "Name of the location", "example": "Worksite #1", "type": "string" } }, "required": [ "address", "latitude", "longitude", "name" ], "type": "object" }, "PatchResponseWorkflowConfigurationObjectResponseBody": { "description": "The configuration of a alert.", "properties": { "actions": { "description": "An array of actions.", "items": { "$ref": "#/components/schemas/ActionObjectResponseBody" }, "type": "array" }, "createdAtTime": { "description": "The time the configuration was created in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unqiue Samsara id of the alert configuration.", "example": "e1c5dffc-c7b7-47b0-a778-6a65de638abf", "type": "string" }, "isEnabled": { "default": true, "description": "Whether the alert is enabled or not.", "example": true, "type": "boolean" }, "lastModifiedAtTime": { "description": "The time the configuration was last modified in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "name": { "description": "The custom name of the configuration.", "example": "My Harsh Event Alert", "type": "string" }, "operationalSettings": { "$ref": "#/components/schemas/OperationalSettingsObjectResponseBody" }, "scope": { "$ref": "#/components/schemas/ScopeObjectResponseBody" }, "triggers": { "description": "An array of triggers.", "items": { "$ref": "#/components/schemas/WorkflowTriggerObjectResponseBody" }, "type": "array" } }, "required": [ "actions", "createdAtTime", "id", "isEnabled", "lastModifiedAtTime", "name", "scope", "triggers" ], "type": "object" }, "PatchShippingDocsResponseBodyResponseBody": { "description": "Response after successfully updating the LogMetaData object.", "properties": { "adverseDrivingClaimed": { "description": "Whether the driver has claimed the [Adverse Driving Exemption](https://kb.samsara.com/hc/en-us/articles/360047336792-Adverse-Driving-Exemption) for this HOS day chart.", "example": true, "type": "boolean" }, "bigDayClaimed": { "description": "Whether the driver has claimed the [Big Day Exemption](https://kb.samsara.com/hc/en-us/articles/360057113891-16-Hour-Short-Haul-Exemption-Big-Day-) for this HOS day chart.", "example": false, "type": "boolean" }, "carrierFormattedAddress": { "description": "The address of the carrier used for this HOS chart.", "example": "1990 Alameda Street, San Francisco, CA 94103", "type": "string" }, "carrierName": { "description": "The name of the carrier used for this HOS chart.", "example": "Carrier Name", "type": "string" }, "carrierUsDotNumber": { "description": "The US DOT number of the carrier used for this HOS chart.", "example": 1234, "format": "int64", "type": "integer" }, "homeTerminalFormattedAddress": { "description": "The address of the Home Terminal used for this HOS chart.", "example": "1990 Alameda Street, San Francisco, CA 94103", "type": "string" }, "homeTerminalName": { "description": "The name of the Home Terminal used for this HOS chart.", "example": "Home Terminal Name", "type": "string" }, "isCertified": { "description": "Whether this HOS day chart was certified by the driver.", "example": true, "type": "boolean" }, "isUsShortHaulActive": { "description": "Whether the driver has the 150 air-mile Short Haul Exemption active for this HOS day chart.", "example": false, "type": "boolean" }, "trailerNames": { "description": "List of trailer names associated with the driver for the day. If a trailer was associated with a log through the driver app, the trailer name will be the trailer ID.", "example": [ "10293", "Trailer ID 1" ], "items": { "example": "Nemo qui nulla dolor consectetur.", "type": "string" }, "type": "array" } }, "type": "object" }, "PatchTagRequest": { "properties": { "addresses": { "description": "The addresses that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "assets": { "description": "The trailers, unpowered, and powered assets that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "drivers": { "description": "The drivers that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "machines": { "description": "The machines that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "name": { "description": "Name of this tag.", "example": "California", "maxLength": 191, "minLength": 1, "type": "string" }, "parentTagId": { "description": "If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.", "example": "4815", "type": "string" }, "sensors": { "description": "The sensors that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "vehicles": { "description": "The vehicles that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" } }, "type": "object" }, "PeerGroupTagId": { "description": "The tag id of the peer group this driver belong to, used for gamification, leave blank for group with everyone.", "example": "1234", "type": "string" }, "PendingDutyStatusDurationsObjectResponseBody": { "description": "What the duty status durations on the driver’s log would be if all pending carrier edits are accepted by the driver.", "properties": { "activeDurationMs": { "description": "Duration the driver was active for in the log period in milliseconds.", "example": 38825000, "format": "int64", "type": "integer" }, "driveDurationMs": { "description": "Duration the driver was driving for in the log period in milliseconds.", "example": 31970000, "format": "int64", "type": "integer" }, "offDutyDurationMs": { "description": "Duration the driver was off duty for in the log period in milliseconds.", "example": 20555000, "format": "int64", "type": "integer" }, "onDutyDurationMs": { "description": "Duration the driver was on duty for in the log period in milliseconds.", "example": 5423000, "format": "int64", "type": "integer" }, "personalConveyanceDurationMs": { "description": "Duration the driver was driving for personal conveyance for in the log period in milliseconds.", "example": 4358000, "format": "int64", "type": "integer" }, "sleeperBerthDurationMs": { "description": "Duration the driver was in their sleeper berth for in the log period in milliseconds.", "example": 27020000, "format": "int64", "type": "integer" }, "waitingTimeDurationMs": { "description": "Duration the driver was waiting for in the log period in milliseconds.", "example": 1560000, "format": "int64", "type": "integer" }, "yardMoveDurationMs": { "description": "Duration the driver was driving for yard moves for in the log period in milliseconds.", "example": 1432000, "format": "int64", "type": "integer" } }, "type": "object" }, "PersonDetectedResponseBody": { "description": "Details specific to Person Detected.", "properties": { "cameraStream": { "$ref": "#/components/schemas/alertObjectOnvifCameraStreamResponseBody" } }, "type": "object" }, "PolicyViolationsDetectionAlertSettingsObjectResponseBody": { "description": "Enables detection of policy violations, surfaces events in Safety Inbox, and enables configurable alerts. While the feature is in beta, in-cab alerts are recommended for testing use only.", "properties": { "eventsAvailableForTesting": { "description": "List of selectable beta policy violation events to be tested.", "example": [ "smoking", "eatingDrinking" ], "items": { "description": "Enables testing for selected policy violation beta events. Valid values: `mobileUsage`, `smoking`, `eatingDrinking`, `inwardCameraObstruction`, `outwardCameraObstruction`", "enum": [ "mobileUsage", "smoking", "eatingDrinking", "inwardCameraObstruction", "outwardCameraObstruction" ], "example": "smoking", "type": "string" }, "type": "array" }, "eventsToCoach": { "description": "List of selectable policy violation events to enable coaching for.", "example": [ "noSeatbelt", "noMask" ], "items": { "description": "Enables coaching for selected policy violation events. Valid values: `noSeatbelt`, `noMask`, `mobileUsage`, `smoking`, `eatingDrinking`, `inwardCameraObstruction`, `outwardCameraObstruction`", "enum": [ "noSeatbelt", "noMask", "mobileUsage", "smoking", "eatingDrinking", "inwardCameraObstruction", "outwardCameraObstruction" ], "example": "noSeatbelt", "type": "string" }, "type": "array" }, "hasInCabAudioAlertsEnabled": { "description": "Indicates whether in-cab audio alerts for rolling stops are turned on.", "example": true, "type": "boolean" }, "isEnabled": { "description": "Indicates whether AI event detection for rolling stops is turned on.", "example": true, "type": "boolean" }, "speedingThresholdMph": { "description": "Alert when speed is over this many miles per hour.", "example": 5, "format": "double", "type": "number" } }, "type": "object" }, "PolygonRequestBody": { "description": "Information about a polygon geofence. This field is only needed if the geofence is a polygon.", "properties": { "name": { "description": "The name of the polygon.", "example": "My Geofence Polygon", "type": "string" }, "vertices": { "description": "The vertices of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.", "items": { "$ref": "#/components/schemas/VertexRequestBody" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "PolygonResponseBody": { "description": "Information about a polygon geofence. This field is only needed if the geofence is a polygon.", "properties": { "name": { "description": "The name of the polygon.", "example": "My Geofence Polygon", "type": "string" }, "vertices": { "description": "The vertices of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.", "items": { "$ref": "#/components/schemas/VertexResponseBody" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "PostCustomReportRunResponseObjectResponseBody": { "description": "Full post custom report run response object", "properties": { "createdAtTime": { "description": "Time of when the custom report run was created and queued in UTC.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "customReportId": { "description": "Unique Id for the custom report (config) linked to this run.", "example": "a0befd37-54f0-41de-991c-ee1e031134d2", "type": "string" }, "id": { "description": "Unique id for the custom report run object.", "example": "4f71fd67-54f0-41de-991c-ee1e031134d1", "type": "string" } }, "required": [ "createdAtTime", "customReportId", "id" ], "type": "object" }, "PostDriverTrailerAssignmentsResponseBodyResponseBody": { "description": "Response after successfully submitting a Driver Trailer Assignment", "properties": { "createdAtTime": { "description": "Time when the driver trailer assignment was created, in RFC 3339 format", "example": "2019-06-13T19:08:25Z", "type": "string" }, "driverId": { "description": "Samsara ID for the driver that this assignment is for.", "example": "0987", "type": "string" }, "id": { "description": "Samsara ID for the assignment.", "example": "08b3aeada5f4ab3010c0b4efa28d2d1890dbf8d48d2d6", "type": "string" }, "startTime": { "description": "Time when the driver trailer assignment starts, in RFC 3339 format", "example": "2019-06-13T19:08:25Z", "type": "string" }, "trailerId": { "description": "Samsara ID of the trailer", "example": "494123", "type": "string" }, "updatedAtTime": { "description": "Time when the driver trailer assignment was last updated, in RFC 3339 format", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "required": [ "createdAtTime", "driverId", "id", "startTime", "trailerId", "updatedAtTime" ], "type": "object" }, "PostDriverVehicleAssignmentsV2RequestBodyMetadataRequestBody": { "description": "Metadata about this driver assignment", "properties": { "sourceName": { "description": "Describes where the external assignment is coming from", "example": "My custom assignment source", "maxLength": 100, "type": "string" } }, "type": "object" }, "PostDriverVehicleAssignmentsV2ResponseBodyResponseBody": { "description": "Response after successfully submitting a Driver Assignment", "properties": { "message": { "description": "A description of the outcome from submitting Driver Assignment information", "example": "Driver assignment was successfully submitted", "type": "string" } }, "type": "object" }, "PostFuelPurchaseRequestBodyPriceRequestBody": { "description": "The price of the fuel transaction in the currency of the country where the transaction occurred.", "properties": { "amount": { "description": "The money amount.", "example": "640.2", "type": "string" }, "currency": { "description": "The currency of money. This is a 3-letter ISO 4217 currency code. Valid values: `usd`, `gbp`, `cad`, `eur`, `chf`, `mxn`", "enum": [ "usd", "gbp", "cad", "eur", "chf", "mxn" ], "example": "usd", "type": "string" } }, "required": [ "amount", "currency" ], "type": "object" }, "PostFuelPurchaseResponseBodyResponseBody": { "description": "Response after successfully adding a Fuel Purchase transaction", "properties": { "uuid": { "description": "Universally unique identifier for the fuel purchase.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" } }, "required": [ "uuid" ], "type": "object" }, "PostJobObjectRequestBody": { "description": "Job object to be created", "properties": { "address": { "$ref": "#/components/schemas/PostJobObjectjobLocationRequestObjectRequestBody" }, "customerName": { "description": "Customer name for job", "example": "Samsara", "type": "string" }, "endDate": { "description": "End date of job in RFC 3339 format. Must be greater than or equal to the start date", "example": "2019-06-13T19:08:25Z", "type": "string" }, "fleetDeviceIds": { "description": "Fleet devices to be added to this job (cannot have both industrial assets and fleet devices in the same job)", "example": [1234567, 654321], "items": { "example": 7.920711547620047e+18, "format": "int64", "type": "integer" }, "type": "array" }, "id": { "description": "Job Id", "example": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "type": "string" }, "industrialAssetIds": { "description": "IndustrialAssets to be added to this job (cannot have both industrial assets and fleet devices in the same job)", "example": [ "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "ba84a7e2-9c8d-481f-a248-7cce6b22be9d" ], "items": { "example": "Doloremque sit ratione aut et dolores dolores.", "type": "string" }, "type": "array" }, "name": { "description": "Job name", "example": "My Job Name", "type": "string" }, "notes": { "description": "Notes for the upcoming job", "example": "These are my notes", "maxLength": 2000, "type": "string" }, "ontimeWindowAfterArrivalMs": { "description": "Specifies the time window (in milliseconds) after a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "maximum": 259200000, "minimum": 0, "type": "integer" }, "ontimeWindowBeforeArrivalMs": { "description": "Specifies the time window (in milliseconds) before a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "maximum": 259200000, "minimum": 0, "type": "integer" }, "startDate": { "description": "Start date of job in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "required": [ "endDate", "id", "name", "startDate" ], "type": "object" }, "PostJobObjectjobLocationRequestObjectRequestBody": { "description": "A location object for the job", "properties": { "address": { "description": "Address of a location", "example": "1990 Alameda st, San Francisco, Ca 94103", "type": "string" }, "latitude": { "description": "Latitude of a location", "example": 37.456345, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of a location", "example": 34.5633749, "format": "double", "type": "number" }, "name": { "description": "Name of the location", "example": "Worksite #1", "type": "string" } }, "required": [ "address", "latitude", "longitude", "name" ], "type": "object" }, "PostMediaRetrievalObjectResponseBody": { "properties": { "retrievalId": { "description": "Retrieval ID associated with this media capture request. Examples: 2308cec4-82e0-46f1-8b3c-a3592e5cc21e", "example": "2308cec4-82e0-46f1-8b3c-a3592e5cc21e", "type": "string" } }, "required": [ "retrievalId" ], "type": "object" }, "PostResponseResWorkflowConfigurationObjectResponseBody": { "description": "The configuration of a alert.", "properties": { "actions": { "description": "An array of actions.", "items": { "$ref": "#/components/schemas/ActionObjectResponseBody" }, "type": "array" }, "createdAtTime": { "description": "The time the configuration was created in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unqiue Samsara id of the alert configuration.", "example": "e1c5dffc-c7b7-47b0-a778-6a65de638abf", "type": "string" }, "isEnabled": { "default": true, "description": "Whether the alert is enabled or not.", "example": true, "type": "boolean" }, "lastModifiedAtTime": { "description": "The time the configuration was last modified in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "type": "string" }, "name": { "description": "The custom name of the configuration.", "example": "My Harsh Event Alert", "type": "string" }, "operationalSettings": { "$ref": "#/components/schemas/OperationalSettingsObjectResponseBody" }, "scope": { "$ref": "#/components/schemas/ScopeObjectResponseBody" }, "triggers": { "description": "An array of triggers.", "items": { "$ref": "#/components/schemas/WorkflowTriggerObjectResponseBody" }, "type": "array" } }, "required": [ "actions", "createdAtTime", "id", "isEnabled", "lastModifiedAtTime", "name", "scope", "triggers" ], "type": "object" }, "PowerTakeOffDurationMs": { "description": "Time spent with power take off enabled while idling in milliseconds.", "type": "number" }, "PushNotificationOptionsObjectRequestBody": { "description": "Options for push notifications", "properties": { "isEnabled": { "default": true, "description": "Whether push notifications are enabled.", "example": true, "type": "boolean" } }, "required": [ "isEnabled" ], "type": "object" }, "PushNotificationOptionsObjectResponseBody": { "description": "Options for push notifications", "properties": { "isEnabled": { "default": true, "description": "Whether push notifications are enabled.", "example": true, "type": "boolean" } }, "required": [ "isEnabled" ], "type": "object" }, "QrCodeResponseObjectResponseBody": { "description": "A single document.", "properties": { "driverId": { "description": "ID for the driver the QR code belongs to.", "example": 494123, "format": "int64", "type": "integer" }, "qrCodeLink": { "description": "URL link to the driver assignment QR code. Included if a QR code has been created for the driver.", "example": "https://cloud.samsara.com/qr_code/18979ef6-663e-446b-8d5a-0ff0781b8bab", "type": "string" } }, "required": [ "driverId" ], "type": "object" }, "RecipientObjectRequestBody": { "description": "Recipient of an Action. One of userId contactId or roleId needs to be set.", "properties": { "contactId": { "description": "The ID of the contact.", "example": "1234", "type": "string" }, "notificationTypes": { "description": "How the user/contact/role should be notified.", "example": [ "push", "push", "sms", "sms" ], "items": { "description": "The type of notification. Valid values: `push`, `sms`, `email`", "enum": [ "push", "sms", "email" ], "example": "sms", "type": "string" }, "type": "array" }, "roleId": { "description": "The ID of the role.", "example": "67004a16-be3c-4ef6-a51b-1c45a2c27a92", "type": "string" }, "type": { "description": "The type of recipients Valid values: `user`, `contact`, `role`", "enum": [ "user", "contact", "role" ], "example": "user", "type": "string" }, "userId": { "description": "The ID of the user.", "example": "1234", "type": "string" } }, "required": [ "type" ], "type": "object" }, "RecipientObjectResponseBody": { "description": "Recipient of an Action. One of userId contactId or roleId needs to be set.", "properties": { "contactId": { "description": "The ID of the contact.", "example": "1234", "type": "string" }, "notificationTypes": { "description": "How the user/contact/role should be notified.", "example": [ "push", "sms" ], "items": { "description": "The type of notification. Valid values: `push`, `sms`, `email`", "enum": [ "push", "sms", "email" ], "example": "sms", "type": "string" }, "type": "array" }, "roleId": { "description": "The ID of the role.", "example": "67004a16-be3c-4ef6-a51b-1c45a2c27a92", "type": "string" }, "type": { "description": "The type of recipients Valid values: `user`, `contact`, `role`", "enum": [ "user", "contact", "role" ], "example": "user", "type": "string" }, "userId": { "description": "The ID of the user.", "example": "1234", "type": "string" } }, "required": [ "type" ], "type": "object" }, "ReeferTemperatureResponseBody": { "description": "Details specific to Reefer Temperature.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "ReplaceTagRequest": { "properties": { "addresses": { "description": "The addresses that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "assets": { "description": "The trailers, unpowered, and powered assets that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "drivers": { "description": "The drivers that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "machines": { "description": "The machines that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "name": { "description": "Name of this tag.", "example": "California", "maxLength": 191, "minLength": 1, "type": "string" }, "parentTagId": { "description": "If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.", "example": "4815", "type": "string" }, "sensors": { "description": "The sensors that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" }, "vehicles": { "description": "The vehicles that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObjectId" }, "type": "array" } }, "type": "object" }, "ResolvedBy": { "description": "Information about the user who is resolving a defect.", "properties": { "id": { "description": "The Id of user who is resolving the defect.", "example": "11", "type": "string" }, "type": { "description": "The type of user who is resolving the defect. Must be \"mechanic\".", "enum": [ "mechanic" ], "example": "mechanic", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "ReverseGeoObjectResponseBody": { "description": "Reverse geocoded information", "properties": { "formattedLocation": { "description": "Formatted address of the reverse geocoding data.", "example": "850 Made Up Lane, Orange, CA", "type": "string" } }, "type": "object" }, "RollingStopDetectionAlertSettingsObjectResponseBody": { "description": "AI event detection settings for the rolling stop behavior. Detection is available in vehicles with compatible dash cams.", "properties": { "isEnabled": { "description": "Indicates whether AI event detection for rolling stops is turned on.", "example": true, "type": "boolean" }, "speedingThresholdMph": { "description": "Alert when speed is over this many miles per hour.", "example": 0, "format": "double", "type": "number" } }, "type": "object" }, "RouteChangesResponseBody": { "description": "A diff of the changes for a route update.", "properties": { "after": { "$ref": "#/components/schemas/MinimalRouteAuditLogsResponseBody" }, "before": { "$ref": "#/components/schemas/MinimalRouteAuditLogsResponseBody" } }, "required": [ "after", "before" ], "type": "object" }, "RouteFeedObjectResponseBody": { "description": "Route feed object.", "properties": { "changes": { "$ref": "#/components/schemas/RouteChangesResponseBody" }, "operation": { "description": "The operation that was performed as part of this route update. Valid values: `stop scheduled`, `stop en route`, `stop skipped`, `stop arrived`, `stop departed`, `stop ETA updated`, `stop arrival time updated`, `stop completion time updated`, `stop order changed`, `stop arrival prevented`", "enum": [ "stop scheduled", "stop en route", "stop skipped", "stop arrived", "stop departed", "stop ETA updated", "stop arrival time updated", "stop completion time updated", "stop order changed", "stop arrival prevented" ], "example": "stop skipped", "type": "string" }, "route": { "$ref": "#/components/schemas/baseRouteResponseObjectResponseBody" }, "source": { "description": "The source of this route update. Updates that are triggered by time or by the route being completed are 'automatic'. Valid values: `automatic`, `driver`, `admin`", "enum": [ "automatic", "driver", "admin" ], "example": "automatic", "type": "string" }, "time": { "description": "The timestamp of the route in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "format": "date-time", "type": "string" }, "type": { "description": "The type of route update. The route tracking updates occur as a route is completed and stops transition from one state to another. Currently only Route Tracking updates are supported, but this will change in the future when additional types are added. Valid values: `route tracking`", "enum": [ "route tracking" ], "example": "route tracking", "type": "string" } }, "required": [ "changes", "route", "source", "time", "type" ], "type": "object" }, "RouteSettingsRequestBody": { "description": "An optional dictionary, only necessary to override the defaults for route start and end conditions.", "properties": { "routeCompletionCondition": { "default": "arriveLastStop", "description": "Defaults to 'arriveLastStop' which ends the route upon arriving at the final stop. The condition 'departLastStop' \nends the route upon departing the last stop. If 'arriveLastStop' is set, then the departure time of the final stop should not be set. Valid values: `arriveLastStop`, `departLastStop`", "enum": [ "arriveLastStop", "departLastStop" ], "example": "arriveLastStop", "type": "string" }, "routeStartingCondition": { "default": "departFirstStop", "description": "Defaults to 'departFirstStop' which starts the route upon departing the first stop in the route.\n The condition 'arriveFirstStop' starts the route upon arriving at the first stop in the route. If 'departFirstStop' is set,\nthe arrival time of the first stop should not be set. Valid values: `departFirstStop`, `arriveFirstStop`", "enum": [ "departFirstStop", "arriveFirstStop" ], "example": "departFirstStop", "type": "string" } }, "type": "object" }, "RouteSettingsResponseBody": { "description": "An optional dictionary, only necessary to override the defaults for route start and end conditions.", "properties": { "routeCompletionCondition": { "default": "arriveLastStop", "description": "Defaults to 'arriveLastStop' which ends the route upon arriving at the final stop. The condition 'departLastStop' \nends the route upon departing the last stop. If 'arriveLastStop' is set, then the departure time of the final stop should not be set. Valid values: `arriveLastStop`, `departLastStop`", "enum": [ "arriveLastStop", "departLastStop" ], "example": "arriveLastStop", "type": "string" }, "routeStartingCondition": { "default": "departFirstStop", "description": "Defaults to 'departFirstStop' which starts the route upon departing the first stop in the route.\n The condition 'arriveFirstStop' starts the route upon arriving at the first stop in the route. If 'departFirstStop' is set,\nthe arrival time of the first stop should not be set. Valid values: `departFirstStop`, `arriveFirstStop`", "enum": [ "departFirstStop", "arriveFirstStop" ], "example": "departFirstStop", "type": "string" } }, "type": "object" }, "RouteStopDetailsObjectResponseBody": { "properties": { "driver": { "$ref": "#/components/schemas/GoaDriverTinyResponseResponseBody" }, "operation": { "description": "The operation that was performed as part of this route update. Valid values: `stop arrived`, `stop departed`", "enum": [ "stop arrived", "stop departed" ], "example": "stop arrived", "type": "string" }, "route": { "$ref": "#/components/schemas/WebhookRouteResponseObjectResponseBody" }, "routeStopDetails": { "$ref": "#/components/schemas/MinimalRouteStopResponseBody" }, "time": { "description": "The timestamp of the route in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "format": "date-time", "type": "string" }, "type": { "description": "The type of route update. The route tracking updates occur as a route is completed and stops transition from one state to another. Currently only Route Tracking updates are supported, but this will change in the future when additional types are added. Valid values: `route tracking`", "enum": [ "route tracking" ], "example": "route tracking", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/VehicleWithGatewayTinyResponseResponseBody" } }, "required": [ "route", "routeStopDetails", "time", "type" ], "type": "object" }, "RouteStopETAResponseBody": { "description": "Details specific to Route Stop ETA.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "RouteStopEstimatedArrivalDetailsObjectRequestBody": { "description": "Details specific to Route Stop Estimated Arrival", "properties": { "alertBeforeArrivalMilliseconds": { "description": "Time threshold for when to send an alert. Sends an alert when the ETA is less than the threshold.", "example": 300000, "format": "int64", "type": "integer" }, "hasLiveShareLink": { "description": "If true, will include a live sharing link in the alert. Defaults to false.", "example": true, "type": "boolean" }, "isAlertOnRouteStopOnly": { "description": "If true, will only alert if the vehicle is en-route to the stop. Defaults to false.", "example": true, "type": "boolean" }, "location": { "$ref": "#/components/schemas/LocationObjectRequestBody" } }, "required": [ "alertBeforeArrivalMilliseconds", "location" ], "type": "object" }, "RouteStopEstimatedArrivalDetailsObjectResponseBody": { "description": "Details specific to Route Stop Estimated Arrival", "properties": { "alertBeforeArrivalMilliseconds": { "description": "Time threshold for when to send an alert. Sends an alert when the ETA is less than the threshold.", "example": 300000, "format": "int64", "type": "integer" }, "hasLiveShareLink": { "description": "If true, will include a live sharing link in the alert. Defaults to false.", "example": true, "type": "boolean" }, "isAlertOnRouteStopOnly": { "description": "If true, will only alert if the vehicle is en-route to the stop. Defaults to false.", "example": true, "type": "boolean" }, "location": { "$ref": "#/components/schemas/LocationObjectResponseBody" } }, "required": [ "alertBeforeArrivalMilliseconds", "location" ], "type": "object" }, "RoutesCreateRouteBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesCreateRouteBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesCreateRouteGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesCreateRouteInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesCreateRouteMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesCreateRouteNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesCreateRouteNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesCreateRouteRequestBody": { "properties": { "driverId": { "description": "ID of the driver. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the driver.", "example": "1234", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "name": { "description": "Name for the route", "example": "Bid 123", "type": "string" }, "notes": { "description": "Notes about the route.", "example": "These are my notes", "maxLength": 2000, "type": "string" }, "settings": { "$ref": "#/components/schemas/RouteSettingsRequestBody" }, "stops": { "description": "List of stops along the route. For each stop, exactly one of `addressId` and `singleUseLocation` are required. Depending on the `settings` on your route, either a `scheduledArrivalTime` or `scheduledDepartureTime` must be specified for the first job.", "items": { "$ref": "#/components/schemas/CreateRoutesStopRequestObjectRequestBody" }, "minItems": 2, "type": "array" }, "vehicleId": { "description": "ID of the vehicle. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the vehicle.", "example": "453546", "type": "string" } }, "required": [ "name", "stops" ], "type": "object" }, "RoutesCreateRouteResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/baseRouteResponseObjectResponseBody" } }, "type": "object" }, "RoutesCreateRouteServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesCreateRouteTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesCreateRouteUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesDeleteRouteUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/baseRouteResponseObjectResponseBody" } }, "type": "object" }, "RoutesFetchRouteServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRouteUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesResponseBody": { "properties": { "data": { "description": "An array containing multiple routes.", "items": { "$ref": "#/components/schemas/baseRouteResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "RoutesFetchRoutesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesFetchRoutesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedResponseBody": { "properties": { "data": { "description": "Route feed response.", "items": { "$ref": "#/components/schemas/RouteFeedObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "RoutesGetRoutesFeedServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesGetRoutesFeedUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteRequestBody": { "properties": { "driverId": { "description": "ID of the driver. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the driver.", "example": "1234", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "name": { "description": "Name for the route", "example": "Bid 123", "type": "string" }, "notes": { "description": "Notes about the route.", "example": "These are my notes", "maxLength": 2000, "type": "string" }, "settings": { "$ref": "#/components/schemas/RouteSettingsRequestBody" }, "stops": { "description": "List of stops along the route. If a valid `id` of a stop is provided, that stop will be updated. If no `id` is provided for a passed in stop, that stop will be created. If `id` value are passed in for some stops and not for others, those with `id` value specified will be retained and updated in the original route, those without `id` value specified in the body will be created, and those without `id` value specified that already existed on the route will be deleted. For each new stop, exactly one of `addressId` and `singleUseLocation` are required. Depending on the `settings` on your route, either a `scheduledArrivalTime` or `scheduledDepartureTime` must be specified for the first job, if a new first job is being added.", "items": { "$ref": "#/components/schemas/UpdateRoutesStopRequestObjectRequestBody" }, "type": "array" }, "vehicleId": { "description": "ID of the vehicle. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the vehicle.", "example": "453546", "type": "string" } }, "type": "object" }, "RoutesPatchRouteResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/baseRouteResponseObjectResponseBody" } }, "type": "object" }, "RoutesPatchRouteServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesPatchRouteUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "RoutesSingleUseAddressObjectRequestBody": { "description": "This field is used to indicate stops along the route for which an address has not been persisted. This field is mutually exclusive with addressId.", "properties": { "address": { "description": "Address of the stop.", "example": "1234 Main St, San Jose, CA", "maxLength": 255, "type": "string" }, "latitude": { "description": "The latitude of the location", "example": 123.456, "format": "double", "type": "number" }, "longitude": { "description": "The longitude of the location", "example": 37.459, "format": "double", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "RoutesSingleUseAddressObjectResponseBody": { "description": "This field is used to indicate stops along the route for which an address has not been persisted. This field is mutually exclusive with addressId.", "properties": { "address": { "description": "Address of the stop.", "example": "1234 Main St, San Jose, CA", "maxLength": 255, "type": "string" }, "latitude": { "description": "The latitude of the location", "example": 123.456, "format": "double", "type": "number" }, "longitude": { "description": "The longitude of the location", "example": 37.459, "format": "double", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "RoutesStopResponseObjectResponseBody": { "properties": { "actualArrivalTime": { "description": "Actual arrival time, if it exists, for the route stop in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "actualDepartureTime": { "description": "Actual departure time, if it exists, for the route stop in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "address": { "$ref": "#/components/schemas/GoaAddressTinyResponseResponseBody" }, "documents": { "description": "List of documents associated with the stop.", "items": { "$ref": "#/components/schemas/GoaDocumentTinyResponseResponseBody" }, "type": "array" }, "enRouteTime": { "description": "The time the stop became en-route, in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "eta": { "description": "Estimated time of arrival, if this stop is currently en-route, in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "Id of the stop", "example": "324231", "type": "string" }, "liveSharingUrl": { "description": "The shareable url of the stop's current status.", "example": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token", "type": "string" }, "locationLiveSharingLinks": { "description": "List of shareable, non-expired 'By Location' Live Sharing Links.", "items": { "$ref": "#/components/schemas/LiveSharingLinkResponseObjectResponseBody" }, "type": "array" }, "name": { "description": "Name of the stop", "example": "Stop #1", "type": "string" }, "notes": { "description": "Notes for the stop", "example": "These are my notes", "maxLength": 2000, "type": "string" }, "ontimeWindowAfterArrivalMs": { "description": "Specifies the time window (in milliseconds) after a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "format": "int64", "type": "integer" }, "ontimeWindowBeforeArrivalMs": { "description": "Specifies the time window (in milliseconds) before a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "format": "int64", "type": "integer" }, "scheduledArrivalTime": { "description": "Scheduled arrival time, if it exists, for the stop in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "scheduledDepartureTime": { "description": "Scheduled departure time, if it exists, for the stop in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "singleUseLocation": { "$ref": "#/components/schemas/RoutesSingleUseAddressObjectResponseBody" }, "skippedTime": { "description": "Skipped time, if it exists, for the route stop in RFC 3339 format.", "example": "2006-01-02T15:04:05+07:00", "format": "date-time", "type": "string" }, "state": { "description": "The current state of the route stop. Valid values: `unassigned`, `scheduled`, `en route`, `skipped`, `arrived`, `departed`", "enum": [ "unassigned", "scheduled", "en route", "skipped", "arrived", "departed" ], "example": "scheduled", "type": "string" } }, "required": [ "id", "name", "state" ], "type": "object" }, "SafetyEvent": { "description": "A safety event.", "properties": { "behaviorLabels": { "$ref": "#/components/schemas/SafetyEventBehaviorLabels" }, "coachingState": { "$ref": "#/components/schemas/SafetyEventCoachingState" }, "downloadForwardVideoUrl": { "$ref": "#/components/schemas/SafetyEventDownloadForwardVideoUrl" }, "downloadInwardVideoUrl": { "$ref": "#/components/schemas/SafetyEventDownloadInwardVideoUrl" }, "downloadTrackedInwardVideoUrl": { "$ref": "#/components/schemas/SafetyEventDownloadTrackedInwardVideoUrl" }, "driver": { "$ref": "#/components/schemas/driverTinyResponse" }, "id": { "$ref": "#/components/schemas/SafetyEventId" }, "location": { "$ref": "#/components/schemas/location" }, "maxAccelerationGForce": { "$ref": "#/components/schemas/SafetyEventMaxAccelerationGForce" }, "time": { "$ref": "#/components/schemas/SafetyEventTime" }, "vehicle": { "$ref": "#/components/schemas/vehicleTinyResponse" } }, "type": "object" }, "SafetyEventActivityFeedItemResponseBody": { "description": "Safety event activity feed item.", "properties": { "id": { "description": "The ID of the activity event feed line item.", "example": "1622151765-212014918174029-1550954461759", "type": "string" }, "safetyEvent": { "$ref": "#/components/schemas/SafetyEventObjectResponseBody" }, "time": { "description": "The time the activity occurred in the corresponding safety event in RFC 3339 milliseconds format.", "example": "2019-10-12T07:20:50.52Z", "type": "string" }, "type": { "description": "The type of activity that occurred in the safety event. We currently only support CoachingStateActivityType, BehaviorLabelActivityType, and CreateSafetyEventActivityType, but we may add support for more activity types in the future. Valid values: `BehaviorLabelActivityType`, `CoachingStateActivityType`, `CreateSafetyEventActivityType`", "enum": [ "BehaviorLabelActivityType", "CoachingStateActivityType", "CreateSafetyEventActivityType" ], "example": "CreateSafetyEventActivityType", "type": "string" } }, "required": [ "id", "safetyEvent", "time", "type" ], "type": "object" }, "SafetyEventBehaviorLabel": { "description": "The label and source of the label associated with the safety event.", "properties": { "label": { "$ref": "#/components/schemas/SafetyEventBehaviorLabelType" }, "name": { "$ref": "#/components/schemas/SafetyEventBehaviorLabelName" }, "source": { "$ref": "#/components/schemas/SafetyEventBehaviorLabelSource" } }, "required": [ "label", "source" ], "type": "object" }, "SafetyEventBehaviorLabelName": { "description": "The name of the label associated with the safety event.", "example": "Tailgating", "type": "string" }, "SafetyEventBehaviorLabelSource": { "description": "The source of the label associated with the safety event. Valid values: `automated`, `userGenerated`.", "enum": [ "automated", "userGenerated" ], "type": "string" }, "SafetyEventBehaviorLabelType": { "description": "The label associated with the safety event. This list often changes, so it is recommended that clients gracefully handle any types not enumerated in this list. Valid values: `genericTailgating`, `genericDistraction`, `defensiveDriving`, `rollingStop`, `nearCollison`, `speeding`, `obstructedCamera`, `didNotYield`, `noSeatbelt`, `mobileUsage`, `drowsy`, `laneDeparture`, `followingDistanceSevere`, `followingDistanceModerate`, `lateResponse`, `acceleration`, `braking`, `harshTurn`, `crash`, `rolloverProtection`, `yawControl`, `ranRedLight`, `forwardCollisionWarning`, `eatingDrinking`, `smoking`, `followingDistance`, `edgeDistractedDriving`.", "enum": [ "genericTailgating", "genericDistraction", "defensiveDriving", "rollingStop", "nearCollison", "speeding", "obstructedCamera", "didNotYield", "noSeatbelt", "mobileUsage", "drowsy", "laneDeparture", "followingDistanceSevere", "followingDistanceModerate", "lateResponse", "acceleration", "braking", "harshTurn", "crash", "rolloverProtection", "yawControl", "ranRedLight", "forwardCollisionWarning", "eatingDrinking", "smoking", "followingDistance", "edgeDistractedDriving" ], "type": "string" }, "SafetyEventBehaviorLabels": { "description": "The most up-to-date behavior labels associated with the safety event. These labels can be updated by the Safety Report Admin.", "items": { "$ref": "#/components/schemas/SafetyEventBehaviorLabel" }, "type": "array" }, "SafetyEventBehaviorLabelsResponseBody": { "description": "Behavior label for a safety event.", "properties": { "name": { "description": "Name of the behavior label.", "example": "Acceleration", "type": "string" }, "type": { "description": "Type of the BehaviorLabel. Valid values: `Acceleration`, `Braking`, `Crash`, `DefensiveDriving`, `DidNotYield`, `Drinking`, `Drowsy`, `Eating`, `EatingDrinking`, `EdgeDistractedDriving`, `EdgeRailroadCrossingViolation`, `FollowingDistance`, `FollowingDistanceModerate`, `FollowingDistanceSevere`, `ForwardCollisionWarning`, `GenericDistraction`, `GenericTailgating`, `HarshTurn`, `Invalid`, `LaneDeparture`, `LateResponse`, `MobileUsage`, `NearCollison`, `NoSeatbelt`, `ObstructedCamera`, `PolicyViolationMask`, `RanRedLight`, `RollingStop`, `RolloverProtection`, `Smoking`, `Speeding`, `VulnerableRoadUserCollisionWarning`, `YawControl`", "enum": [ "Acceleration", "Braking", "Crash", "DefensiveDriving", "DidNotYield", "Drinking", "Drowsy", "Eating", "EatingDrinking", "EdgeDistractedDriving", "EdgeRailroadCrossingViolation", "FollowingDistance", "FollowingDistanceModerate", "FollowingDistanceSevere", "ForwardCollisionWarning", "GenericDistraction", "GenericTailgating", "HarshTurn", "Invalid", "LaneDeparture", "LateResponse", "MobileUsage", "NearCollison", "NoSeatbelt", "ObstructedCamera", "PolicyViolationMask", "RanRedLight", "RollingStop", "RolloverProtection", "Smoking", "Speeding", "VulnerableRoadUserCollisionWarning", "YawControl" ], "example": "Acceleration", "type": "string" } }, "type": "object" }, "SafetyEventCoachingState": { "description": "The current coaching status of the event. Valid values: `needsReview`, `coached`, `dismissed`, `reviewed`, `archived`, `manualReview`, `needsCoaching`, `autoDismissed`, `needsRecognition`, `recognized`, `invalid`.", "enum": [ "needsReview", "coached", "dismissed", "reviewed", "archived", "manualReview", "needsCoaching", "autoDismissed", "needsRecognition", "recognized", "invalid" ], "type": "string" }, "SafetyEventDownloadForwardVideoUrl": { "description": "URL to download the forward video.", "example": "https://s3.console.aws.amazon.com/s3/buckets/samsara-dashcam-videos/21575/212014918400828/1553060687222/huKA7IhpBV-camera-video-segment-1244214895.mp4", "type": "string" }, "SafetyEventDownloadInwardVideoUrl": { "description": "URL to download the inward video.", "example": "https://s3.console.aws.amazon.com/s3/buckets/samsara-dashcam-videos/21575/212014918400828/1553060687222/huKA7IhpBV-camera-video-segment-1244214895.mp4", "type": "string" }, "SafetyEventDownloadTrackedInwardVideoUrl": { "description": "URL to download the tracked inward video.", "example": "https://s3.console.aws.amazon.com/s3/buckets/samsara-dashcam-videos/21575/212014918400828/1553060687222/huKA7IhpBV-camera-video-segment-1244214895.mp4", "type": "string" }, "SafetyEventDriver": { "$ref": "#/components/schemas/driverTinyResponse" }, "SafetyEventDriverObjectResponseBody": { "description": "A minified driver object.", "properties": { "id": { "description": "ID of the driver.", "example": "0987", "type": "string" } }, "type": "object" }, "SafetyEventId": { "description": "The unique Samsara ID of the safety event.", "example": "212014918174029-1550954461759", "type": "string" }, "SafetyEventLocation": { "$ref": "#/components/schemas/location" }, "SafetyEventMaxAccelerationGForce": { "description": "The maximum acceleration value as a multiplier on the force of gravity (g).", "example": 0.123, "type": "number" }, "SafetyEventObjectResponseBody": { "description": "The safety event that was updated.", "properties": { "behaviorLabels": { "description": "Behavior labels for a safety event.", "items": { "$ref": "#/components/schemas/SafetyEventBehaviorLabelsResponseBody" }, "type": "array" }, "driver": { "$ref": "#/components/schemas/SafetyEventDriverObjectResponseBody" }, "id": { "description": "The unique Samsara ID of the safety event.", "example": "212014918174029-1550954461759", "type": "string" }, "time": { "description": "The time the safety event occurred in RFC 3339 milliseconds format.", "example": "2019-06-13T19:08:25.455Z", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/SafetyEventVehicleObjectResponseBody" } }, "type": "object" }, "SafetyEventTime": { "description": "The time the safety event occurred in RFC 3339 milliseconds format.", "example": "2019-06-13T19:08:25.455Z", "type": "string" }, "SafetyEventVehicle": { "$ref": "#/components/schemas/vehicleTinyResponse" }, "SafetyEventVehicleObjectResponseBody": { "description": "A minified vehicle object.", "properties": { "id": { "description": "ID of the vehicle.", "example": "1234", "type": "string" } }, "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedResponseBody": { "properties": { "data": { "description": "Paginated safety event activity feed limited to 10 events.", "items": { "$ref": "#/components/schemas/SafetyEventActivityFeedItemResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsGetSafetyActivityEventFeedUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetyEventsListResponse": { "description": "List of safety events.", "properties": { "data": { "items": { "$ref": "#/components/schemas/SafetyEvent" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "SafetyScoreConfigurationSettingsObjectResponseBody": { "description": "The configurable safety infraction weights.", "properties": { "aiInattentiveDrivingDetectionWeight": { "description": "Score weight for AI-detected inattentive driving behavior.", "example": 2, "format": "int64", "type": "integer" }, "crashWeight": { "description": "Score weight for crash behavior.", "example": 1, "format": "int64", "type": "integer" }, "defensiveDrivingWeight": { "description": "Score weight for defensive driving behavior. This behavior has a positive impact on the safety score.", "example": 0, "format": "int64", "type": "integer" }, "didNotYieldWeight": { "description": "Score weight for driver not yielding.", "example": 0, "format": "int64", "type": "integer" }, "drowsyWeight": { "description": "Score weight for drowsy behavior.", "example": 0, "format": "int64", "type": "integer" }, "eatingDrinkingWeight": { "description": "Score weight for eating/drinking behavior.", "example": 0, "format": "int64", "type": "integer" }, "followingDistanceModerateWeight": { "description": "Score weight for moderate (2-4s) following distance behavior.", "example": 0, "format": "int64", "type": "integer" }, "followingDistanceSevereWeight": { "description": "Score weight for severe (0-2s) following distance behavior.", "example": 0, "format": "int64", "type": "integer" }, "followingDistanceWeight": { "description": "Score weight for following distance behavior.", "example": 2, "format": "int64", "type": "integer" }, "forwardCollisionWarningWeight": { "description": "Score weight for forward collision warning behavior.", "example": 0, "format": "int64", "type": "integer" }, "harshAccelWeight": { "description": "Score weight for harsh acceleration behavior.", "example": 1, "format": "int64", "type": "integer" }, "harshBrakeWeight": { "description": "Score weight for harsh braking behavior.", "example": 1, "format": "int64", "type": "integer" }, "harshTurnWeight": { "description": "Score weight for harsh turn behavior.", "example": 1, "format": "int64", "type": "integer" }, "heavySpeedingWeight": { "description": "Score weight for heavy speeding (20-30% over limit).", "example": 1, "format": "int64", "type": "integer" }, "inattentiveDrivingWeight": { "description": "Score weight for inattentive driving behavior.", "example": 0, "format": "int64", "type": "integer" }, "laneDepartureWeight": { "description": "Score weight for lane departure behavior.", "example": 0, "format": "int64", "type": "integer" }, "lateResponseWeight": { "description": "Score weight for late response behavior.", "example": 0, "format": "int64", "type": "integer" }, "lightSpeedingWeight": { "description": "Score weight for light speeding (0-10% over limit).", "example": 0, "format": "int64", "type": "integer" }, "maxSpeedWeight": { "description": "Score weight for max speed events.", "example": 1, "format": "int64", "type": "integer" }, "mobileUsageWeight": { "description": "Score weight for mobile usage behavior.", "example": 0, "format": "int64", "type": "integer" }, "moderateSpeedingWeight": { "description": "Score weight for moderate speeding (10-20% over limit).", "example": 1, "format": "int64", "type": "integer" }, "nearCollisionWeight": { "description": "Score weight for near collision behavior.", "example": 0, "format": "int64", "type": "integer" }, "noSeatbeltWeight": { "description": "Score weight for no seatbelt behavior.", "example": 0, "format": "int64", "type": "integer" }, "obstructedCameraWeight": { "description": "Score weight for obstructed camera behavior.", "example": 0, "format": "int64", "type": "integer" }, "ranRedLightWeight": { "description": "Score weight for driver running red light.", "example": 0, "format": "int64", "type": "integer" }, "rollingStopWeight": { "description": "Score weight for rolling stop behavior.", "example": 0, "format": "int64", "type": "integer" }, "severeSpeedingWeight": { "description": "Score weight for severe speeding (over 30% over limit).", "example": 1, "format": "int64", "type": "integer" }, "smokingWeight": { "description": "Score weight for smoking behavior.", "example": 0, "format": "int64", "type": "integer" }, "speedingWeight": { "description": "Score weight for manual speeding event.", "example": 0, "format": "int64", "type": "integer" } }, "type": "object" }, "SafetySettingsGetSafetySettingsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsGetSafetySettingsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsGetSafetySettingsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsGetSafetySettingsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsGetSafetySettingsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsGetSafetySettingsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsGetSafetySettingsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsGetSafetySettingsResponseBody": { "properties": { "data": { "description": "Safety settings for a single organization.", "items": { "$ref": "#/components/schemas/SafetySettingsObjectResponseBody" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "SafetySettingsGetSafetySettingsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsGetSafetySettingsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsGetSafetySettingsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SafetySettingsObjectResponseBody": { "description": "Safety settings for a single organization.", "properties": { "defaultVehicleType": { "description": "Default vehicle type (for newly added or activated vehicles). Valid values: `off`, `automatic`, `passengerCar`, `lightTruck`, `heavyDuty`", "enum": [ "off", "automatic", "passengerCar", "lightTruck", "heavyDuty" ], "example": "heavyDuty", "type": "string" }, "distractedDrivingDetectionAlerts": { "$ref": "#/components/schemas/DistractedDrivingDetectionAlertSettingsObjectResponseBody" }, "followingDistanceDetectionAlerts": { "$ref": "#/components/schemas/FollowingDistanceDetectionAlertSettingsObjectResponseBody" }, "forwardCollisionDetectionAlerts": { "$ref": "#/components/schemas/ForwardCollisionDetectionAlertSettingsObjectResponseBody" }, "harshEventSensitivity": { "$ref": "#/components/schemas/HarshEventSensitivitySettingsObjectResponseBody" }, "harshEventSensitivityV2": { "$ref": "#/components/schemas/HarshEventSensitivityV2SettingsObjectResponseBody" }, "policyViolationsDetectionAlerts": { "$ref": "#/components/schemas/PolicyViolationsDetectionAlertSettingsObjectResponseBody" }, "rollingStopDetectionAlerts": { "$ref": "#/components/schemas/RollingStopDetectionAlertSettingsObjectResponseBody" }, "safetyScoreConfiguration": { "$ref": "#/components/schemas/SafetyScoreConfigurationSettingsObjectResponseBody" }, "safetyScoreTarget": { "description": "The fleet-wide target safety score that is shown on safety score graphs. A safety score goal of 0 means that score benchmarking is disabled.", "example": 90, "format": "int64", "type": "integer" }, "speedingSettings": { "$ref": "#/components/schemas/SpeedingSettingsObjectResponseBody" }, "voiceCoaching": { "$ref": "#/components/schemas/VoiceCoachingSettingsObjectResponseBody" } }, "required": [ "defaultVehicleType", "distractedDrivingDetectionAlerts", "followingDistanceDetectionAlerts", "forwardCollisionDetectionAlerts", "harshEventSensitivity", "harshEventSensitivityV2", "policyViolationsDetectionAlerts", "rollingStopDetectionAlerts", "safetyScoreConfiguration", "safetyScoreTarget", "speedingSettings", "voiceCoaching" ], "type": "object" }, "ScheduledMaintenanceByEngineHoursDetailsObjectRequestBody": { "description": "Details specific to Scheduled Maintenance By Engine Hours", "properties": { "dueInHours": { "description": "Alert when maintenance is due in the specified number of hours.", "example": 5000, "format": "int64", "type": "integer" }, "scheduleId": { "description": "The id of the maintenance schedule.", "example": "123", "type": "string" } }, "required": [ "dueInHours", "scheduleId" ], "type": "object" }, "ScheduledMaintenanceByEngineHoursDetailsObjectResponseBody": { "description": "Details specific to Scheduled Maintenance By Engine Hours", "properties": { "dueInHours": { "description": "Alert when maintenance is due in the specified number of hours.", "example": 5000, "format": "int64", "type": "integer" }, "scheduleId": { "description": "The id of the maintenance schedule.", "example": "123", "type": "string" } }, "required": [ "dueInHours", "scheduleId" ], "type": "object" }, "ScheduledMaintenanceByEngineHoursResponseBody": { "description": "Details specific to Scheduled Maintenance By Engine Hours.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "ScheduledMaintenanceDataResponseBody": { "description": "Details specific to Scheduled Maintenance.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "ScheduledMaintenanceOdometerDataResponseBody": { "description": "Details specific to Scheduled Maintenance By Odometer.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "ScheduledMaintenanceOdometerTriggerDetailsObjectRequestBody": { "description": "Details specific to Scheduled Maintenance by Odometer", "properties": { "dueInMeters": { "description": "Alert when vehicle odometer has this many meters left until maintenance is due.", "example": 5000, "format": "int64", "type": "integer" }, "scheduleId": { "description": "The id of the maintenance schedule.", "example": "123", "type": "string" } }, "required": [ "dueInMeters", "scheduleId" ], "type": "object" }, "ScheduledMaintenanceOdometerTriggerDetailsObjectResponseBody": { "description": "Details specific to Scheduled Maintenance by Odometer", "properties": { "dueInMeters": { "description": "Alert when vehicle odometer has this many meters left until maintenance is due.", "example": 5000, "format": "int64", "type": "integer" }, "scheduleId": { "description": "The id of the maintenance schedule.", "example": "123", "type": "string" } }, "required": [ "dueInMeters", "scheduleId" ], "type": "object" }, "ScheduledMaintenanceTriggerDetailsObjectRequestBody": { "description": "Details specific to Scheduled Maintenance by Date", "properties": { "dueInDays": { "description": "Alert when maintenance is due in the specified number of days.", "example": 10, "format": "int64", "type": "integer" }, "scheduleId": { "description": "The id of the maintenance schedule.", "example": "123", "type": "string" } }, "required": [ "dueInDays", "scheduleId" ], "type": "object" }, "ScheduledMaintenanceTriggerDetailsObjectResponseBody": { "description": "Details specific to Scheduled Maintenance by Date", "properties": { "dueInDays": { "description": "Alert when maintenance is due in the specified number of days.", "example": 10, "format": "int64", "type": "integer" }, "scheduleId": { "description": "The id of the maintenance schedule.", "example": "123", "type": "string" } }, "required": [ "dueInDays", "scheduleId" ], "type": "object" }, "ScopeObjectRequestBody": { "description": "What the triggers are scoped to. These are the objects this alert applies to.", "properties": { "all": { "description": "Whether it applies to all applicable objects.", "example": true, "type": "boolean" }, "assets": { "description": "The assets these triggers are scoped to.", "items": { "$ref": "#/components/schemas/TinyAssetObjectRequestBody" }, "type": "array" }, "drivers": { "description": "The drivers these triggers are scoped to.", "items": { "$ref": "#/components/schemas/TinyDriverObjectRequestBody" }, "type": "array" }, "tags": { "description": "The tags these triggers are scoped to.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseRequestBody" }, "type": "array" }, "widgets": { "description": "The widgets these triggers are scoped to.", "items": { "$ref": "#/components/schemas/TinyWidgetObjectRequestBody" }, "type": "array" } }, "required": [ "all" ], "type": "object" }, "ScopeObjectResponseBody": { "description": "What the triggers are scoped to. These are the objects this alert applies to.", "properties": { "all": { "description": "Whether it applies to all applicable objects.", "example": true, "type": "boolean" }, "assets": { "description": "The assets these triggers are scoped to.", "items": { "$ref": "#/components/schemas/TinyAssetObjectResponseBody" }, "type": "array" }, "drivers": { "description": "The drivers these triggers are scoped to.", "items": { "$ref": "#/components/schemas/TinyDriverObjectResponseBody" }, "type": "array" }, "tags": { "description": "The tags these triggers are scoped to.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" }, "widgets": { "description": "The widgets these triggers are scoped to.", "items": { "$ref": "#/components/schemas/TinyWidgetObjectResponseBody" }, "type": "array" } }, "required": [ "all" ], "type": "object" }, "Sensor": { "properties": { "id": { "description": "ID of the sensor", "type": "string" }, "mac": { "description": "MAC address of the sensor", "type": "string" }, "name": { "description": "Name of the sensor", "type": "string" } }, "required": [ "id", "mac", "name" ], "type": "object" }, "Serial": { "description": "The serial number of the gateway installed in the vehicle.", "example": "VG12345", "type": "string" }, "ServiceTaskDefinitionObjectResponseBody": { "description": "A service task definition object.", "properties": { "category": { "description": "The category of the service task.", "example": "Engine", "type": "string" }, "description": { "description": "A description of the service task.", "example": "Standard oil change service including filter replacement.", "type": "string" }, "estimatedLaborTimeMinutes": { "description": "Estimated time in minutes to complete the task.", "example": 30, "format": "int32", "type": "integer" }, "estimatedPartsCost": { "$ref": "#/components/schemas/WorkOrderMoneyObjectResponseBody" }, "id": { "description": "The unique id of the service task definition.", "example": "abf63a9a-4d75-423d-b49f-38a071e6ce36", "type": "string" }, "name": { "description": "The name of the service task.", "example": "Oil Change", "type": "string" }, "subcategory": { "description": "The subcategory of the service task.", "example": "Oil and Lubrication", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "ServiceTaskInstanceObjectRequestBody": { "description": "Work Order Service Task object.", "properties": { "id": { "description": "ID of the service task instance.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "laborHourlyCost": { "$ref": "#/components/schemas/WorkOrderMoneyObjectRequestBody" }, "laborTimeMinutes": { "description": "The time of labor needed", "example": 60, "format": "int32", "type": "integer" }, "partsCost": { "$ref": "#/components/schemas/WorkOrderMoneyObjectRequestBody" }, "serviceTaskId": { "description": "ID of the service task.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "status": { "description": "The status of the service task. Valid values: `UNKNOWN`, `OPEN`, `IN_PROGRESS`, `ON_HOLD`, `COMPLETED`", "enum": [ "UNKNOWN", "OPEN", "IN_PROGRESS", "ON_HOLD", "COMPLETED" ], "example": "UNKNOWN", "type": "string" } }, "required": [ "id", "serviceTaskId", "status" ], "type": "object" }, "ServiceTaskInstanceObjectResponseBody": { "description": "Work Order Service Task object.", "properties": { "id": { "description": "ID of the service task instance.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "laborHourlyCost": { "$ref": "#/components/schemas/WorkOrderMoneyObjectResponseBody" }, "laborTimeMinutes": { "description": "The time of labor needed", "example": 60, "format": "int32", "type": "integer" }, "partsCost": { "$ref": "#/components/schemas/WorkOrderMoneyObjectResponseBody" }, "serviceTaskId": { "description": "ID of the service task.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "status": { "description": "The status of the service task. Valid values: `UNKNOWN`, `OPEN`, `IN_PROGRESS`, `ON_HOLD`, `COMPLETED`", "enum": [ "UNKNOWN", "OPEN", "IN_PROGRESS", "ON_HOLD", "COMPLETED" ], "example": "UNKNOWN", "type": "string" } }, "required": [ "id", "serviceTaskId", "status" ], "type": "object" }, "SettingsComplianceResponseObjectResponseBody": { "description": "Information set here will be displayed in roadside inspections and in the transferred US DOT datafile.", "properties": { "allowUnregulatedVehiclesEnabled": { "description": "[deprecated] Allow Unregulated Vehicles. This setting is deprecated as all organizations can now mark vehicles as unregulated.", "example": true, "type": "boolean" }, "canadaHosEnabled": { "description": "Enable Canada HOS", "example": true, "type": "boolean" }, "carrierName": { "description": "Carrier name of the organization", "example": "ABC Trucking", "type": "string" }, "dotNumber": { "description": "DOT Number", "example": 12345678, "format": "int64", "type": "integer" }, "driverAutoDutyEnabled": { "description": "Enable Driver Auto-Duty", "example": true, "type": "boolean" }, "editCertifiedLogsEnabled": { "description": "Drivers Can Edit Certified Log", "example": false, "type": "boolean" }, "forceManualLocationForDutyStatusChangesEnabled": { "description": "Force Manual Location For Duty Status Changes", "example": true, "type": "boolean" }, "forceReviewUnassignedHosEnabled": { "description": "Force Review of Unassigned HOS", "example": true, "type": "boolean" }, "mainOfficeFormattedAddress": { "description": "Office Address", "example": "123 Main Street", "type": "string" }, "persistentDutyStatusEnabled": { "description": "Persistent Duty Status", "example": true, "type": "boolean" } }, "type": "object" }, "SettingsGetComplianceSettingsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetComplianceSettingsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetComplianceSettingsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetComplianceSettingsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetComplianceSettingsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetComplianceSettingsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetComplianceSettingsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetComplianceSettingsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/SettingsComplianceResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "SettingsGetComplianceSettingsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetComplianceSettingsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetComplianceSettingsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/DriverAppSettingsResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "SettingsGetDriverAppSettingsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsGetDriverAppSettingsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsRequestBody": { "description": "Information set here will be displayed in roadside inspections and in the transferred US DOT datafile. Can be set or updated through the Samsara Settings page or the API at any time. To override these fields for specific drivers, please visit Driver Settings", "properties": { "allowUnregulatedVehiclesEnabled": { "description": "[deprecated] Allow Unregulated Vehicles. This setting is deprecated as all organizations can now mark vehicles as unregulated.", "example": false, "type": "boolean" }, "canadaHosEnabled": { "description": "Enable Canada HOS", "example": true, "type": "boolean" }, "carrierName": { "description": "Carrier Name / Principal Place of Business Name", "example": "ABC Trucking", "type": "string" }, "dotNumber": { "description": "Carrier US DOT Number", "example": 12345678, "format": "int64", "type": "integer" }, "driverAutoDutyEnabled": { "description": "Enable Driver Auto-Duty", "example": true, "type": "boolean" }, "editCertifiedLogsEnabled": { "description": "Drivers Can Edit Certified Log", "example": true, "type": "boolean" }, "forceManualLocationForDutyStatusChangesEnabled": { "description": "Force Manual Location For Duty Status Changes", "example": true, "type": "boolean" }, "forceReviewUnassignedHosEnabled": { "description": "Force Review of Unassigned HOS", "example": true, "type": "boolean" }, "mainOfficeFormattedAddress": { "description": "Main Office Address / Principal Place of Businesss Address", "example": "123 Main Street", "type": "string" }, "persistentDutyStatusEnabled": { "description": "Persistent Duty Status", "example": true, "type": "boolean" } }, "type": "object" }, "SettingsPatchComplianceSettingsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/SettingsComplianceResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "SettingsPatchComplianceSettingsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchComplianceSettingsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsRequestBody": { "description": "The configuration settings for the Samsara Driver App. Can be set or updated through the Samsara Settings page or the API at any time.", "properties": { "driverFleetId": { "description": "Global login user name for the fleet driver app", "example": "abc-trucking-co", "pattern": "^[a-zA-Z0-9-:]*$", "type": "string" }, "gamification": { "description": "Driver gamification feature. Enabling this will turn on the feature for all drivers using the mobile app. Drivers can be configured into peer groups within the Drivers Page. Unconfigured drivers will be grouped on an organization level.", "example": true, "type": "boolean" }, "gamificationConfig": { "$ref": "#/components/schemas/DriverAppSettingsGamificationConfigTinyObjectRequestBody" }, "orgVehicleSearch": { "description": "Allow drivers to search for vehicles outside of their selection tag when connected to the internet.", "example": true, "type": "boolean" }, "trailerSelection": { "description": "Allow drivers to see and select trailers in the Samsara Driver app. ", "example": true, "type": "boolean" }, "trailerSelectionConfig": { "$ref": "#/components/schemas/DriverAppSettingsTrailerSelectionConfigTinyObjectRequestBody" } }, "type": "object" }, "SettingsPatchDriverAppSettingsResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/DriverAppSettingsResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "SettingsPatchDriverAppSettingsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsPatchDriverAppSettingsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SettingsResponseBody": { "description": "Information about a geofence settings.", "properties": { "showAddresses": { "description": "The geofence setting. If this setting set to true, then underlying geofence addresses will be shown in reports instead of a geofence's name.", "items": { "$ref": "#/components/schemas/VertexResponseBody" }, "type": "array" } }, "type": "object" }, "SevereSpeedingStartedObjectResponseBody": { "description": "The start of a severe speeding event", "properties": { "startTime": { "description": "The speeding start time in RFC 3339 format (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "tripStartTime": { "description": "The trip start time in RFC 3339 format (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/VehicleResponseResponseBody" } }, "required": [ "startTime", "vehicle" ], "type": "object" }, "SevereSpeedingStartedResponseObjectResponseBody": { "description": "The start of a severe speeding event", "properties": { "data": { "$ref": "#/components/schemas/SevereSpeedingStartedObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "SignatoryUserObjectResponseBody": { "description": "The user who signed the DVIR.", "properties": { "id": { "description": "ID of the user.", "example": "938172", "type": "string" } }, "required": [ "id" ], "type": "object" }, "SingleApprovalRequirementsObjectResponseBody": { "description": "Single approval requirements object.", "properties": { "roleIds": { "description": "List of role IDs representing which user roles can be approvers.", "example": [ "23d4d8d3-dc10-4e7a-a183-69968751f23e" ], "items": { "example": "Voluptatem eius consequuntur id sed consequuntur pariatur.", "type": "string" }, "type": "array" } }, "required": [ "roleIds" ], "type": "object" }, "SiteGatewayDisconnectedResponseBody": { "description": "Details specific to Site Gateway Disconnected.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "SpecificVehicleFaultCodeObjectRequestBody": { "description": "A specific vehicle fault code.", "properties": { "faultCode": { "description": "The specific fault code name.", "example": "1067", "type": "string" }, "type": { "description": "The specific fault code type. Valid values: `INVALID_FAULT_CODE_TYPE`, `J1939_DTC`, `J1939_SPN`, `PASSENGER_DTC`", "enum": [ "INVALID_FAULT_CODE_TYPE", "J1939_DTC", "J1939_SPN", "PASSENGER_DTC" ], "example": "J1939_SPN", "type": "string" } }, "required": [ "faultCode", "type" ], "type": "object" }, "SpecificVehicleFaultCodeObjectResponseBody": { "description": "A specific vehicle fault code.", "properties": { "faultCode": { "description": "The specific fault code name.", "example": "1067", "type": "string" }, "type": { "description": "The specific fault code type. Valid values: `INVALID_FAULT_CODE_TYPE`, `J1939_DTC`, `J1939_SPN`, `PASSENGER_DTC`", "enum": [ "INVALID_FAULT_CODE_TYPE", "J1939_DTC", "J1939_SPN", "PASSENGER_DTC" ], "example": "J1939_SPN", "type": "string" } }, "required": [ "faultCode", "type" ], "type": "object" }, "SpeedDataResponseBody": { "description": "Details specific to Speed.", "properties": { "currentSpeedKilometersPerHour": { "description": "Current speed of the vehicle in kilometers per hour.", "example": 100, "format": "int32", "type": "integer" }, "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "minDurationMilliseconds": { "description": "Minimum duration of the current speed in milliseconds.", "example": 100000, "format": "int64", "type": "integer" }, "operation": { "description": "Operation of the current and threshold comparison. Valid values: `GREATER`, `INSIDE_RANGE`, `LESS`, `OUTSIDE_RANGE`", "enum": [ "GREATER", "INSIDE_RANGE", "LESS", "OUTSIDE_RANGE" ], "example": "GREATER", "type": "string" }, "thresholdSpeedKilometersPerHour": { "description": "Threshold speed of the vehicle in kilometers per hour.", "example": 100, "format": "int32", "type": "integer" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "required": [ "currentSpeedKilometersPerHour", "minDurationMilliseconds", "operation", "thresholdSpeedKilometersPerHour" ], "type": "object" }, "SpeedResponseResponseBody": { "description": "Speed object.", "properties": { "ecuSpeedMetersPerSecond": { "description": "Speed of asset based on ECU data.", "example": 30.2, "format": "double", "type": "number" }, "gpsSpeedMetersPerSecond": { "description": "Speed of asset based on GPS data.", "example": 30.2, "format": "double", "type": "number" } }, "type": "object" }, "SpeedTriggerDetailsObjectRequestBody": { "description": "Details specific to Speed", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `GREATER`, `LESS`", "enum": [ "GREATER", "LESS" ], "example": "GREATER", "type": "string" }, "speedKilometersPerHour": { "description": "The speed threshold value.", "example": 120, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds", "operation", "speedKilometersPerHour" ], "type": "object" }, "SpeedTriggerDetailsObjectResponseBody": { "description": "Details specific to Speed", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `GREATER`, `LESS`", "enum": [ "GREATER", "LESS" ], "example": "GREATER", "type": "string" }, "speedKilometersPerHour": { "description": "The speed threshold value.", "example": 120, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds", "operation", "speedKilometersPerHour" ], "type": "object" }, "SpeedingIntervalLocationResponseResponseBody": { "description": "Location object of the closest location point to the interval.", "properties": { "accuracyMeters": { "description": "Radial accuracy of gps location in meters. This will only return if strong GPS is not available.", "example": 5.801, "format": "double", "type": "number" }, "address": { "$ref": "#/components/schemas/AddressResponseResponseBody" }, "headingDegrees": { "description": "Heading of the asset in degrees. May be 0 if the asset is not moving.", "example": 120, "format": "int64", "type": "integer" }, "latitude": { "description": "Latitude of the closest location point to the interval.", "example": 37.7749, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the closest location point to the interval.", "example": 137.2719, "format": "double", "type": "number" } }, "required": [ "address", "headingDegrees", "latitude", "longitude" ], "type": "object" }, "SpeedingIntervalResponseBody": { "description": "Speeding Interval Object", "properties": { "endTime": { "description": "UTC time the interval ended in RFC 3339 format.", "example": "2023-01-27T07:06:25Z", "type": "string" }, "isDismissed": { "description": "Whether the interval is dismissed.", "example": true, "type": "boolean" }, "location": { "$ref": "#/components/schemas/SpeedingIntervalLocationResponseResponseBody" }, "maxSpeedKilometersPerHour": { "description": "The max speed exceeded for the speeding interval.", "example": 65, "format": "double", "type": "number" }, "postedSpeedLimitKilometersPerHour": { "description": "The posted speed limit associated with the speeding interval.", "example": 75, "format": "double", "type": "number" }, "severityLevel": { "description": "Specifies the severity level of the speeding interval. Valid values: `light`, `moderate`, `heavy`, `severe`", "enum": [ "light", "moderate", "heavy", "severe" ], "example": "severe", "type": "string" }, "startTime": { "description": "UTC time the interval started in RFC 3339 format.", "example": "2023-01-27T07:06:25Z", "type": "string" } }, "required": [ "endTime", "isDismissed", "location", "maxSpeedKilometersPerHour", "postedSpeedLimitKilometersPerHour", "severityLevel", "startTime" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsResponseBody": { "properties": { "data": { "description": "List of speeding intervals associated with trips.", "items": { "$ref": "#/components/schemas/TripSpeedingIntervalsResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingIntervalsGetSpeedingIntervalsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "SpeedingSettingsObjectResponseBody": { "description": "Enables custom speeding levels.", "properties": { "severityLevels": { "description": "The speeding severity levels for an organization.", "items": { "$ref": "#/components/schemas/speedingSeverityLevelResponseBody" }, "type": "array" }, "unit": { "description": "The unit of measurement for speeding Valid values: `milesPerHour`, `kilometersPerHour`, `percentage`", "enum": [ "milesPerHour", "kilometersPerHour", "percentage" ], "example": "milesPerHour", "type": "string" } }, "type": "object" }, "StringDataPoint": { "description": "A single string data point of a data input.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "String value of the data point.", "example": "On", "format": "string", "type": "string" } }, "type": "object" }, "SuddenFuelLevelDropResponseBody": { "description": "Details specific to Sudden Fuel Level Drop.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "SuddenFuelLevelDropTriggerDetailsObjectRequestBody": { "description": "Details specific to Sudden Fuel Level Drop", "properties": { "minFuelLevelChangeInPercents": { "description": "The minimum fuel level change in percents to trigger on. Need to be between 5 to 100.", "example": 6, "format": "int64", "type": "integer" } }, "required": [ "minFuelLevelChangeInPercents" ], "type": "object" }, "SuddenFuelLevelDropTriggerDetailsObjectResponseBody": { "description": "Details specific to Sudden Fuel Level Drop", "properties": { "minFuelLevelChangeInPercents": { "description": "The minimum fuel level change in percents to trigger on. Need to be between 5 to 100.", "example": 6, "format": "int64", "type": "integer" } }, "required": [ "minFuelLevelChangeInPercents" ], "type": "object" }, "SuddenFuelLevelRiseResponseBody": { "description": "Details specific to Sudden Fuel Level Rise.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "SuddenFuelLevelRiseTriggerDetailsObjectRequestBody": { "description": "Details specific to Sudden Fuel Level Rise", "properties": { "minFuelLevelChangeInPercents": { "description": "The minimum fuel level change in percents to trigger on. Need to be between 5 to 100.", "example": 6, "format": "int64", "type": "integer" } }, "required": [ "minFuelLevelChangeInPercents" ], "type": "object" }, "SuddenFuelLevelRiseTriggerDetailsObjectResponseBody": { "description": "Details specific to Sudden Fuel Level Rise", "properties": { "minFuelLevelChangeInPercents": { "description": "The minimum fuel level change in percents to trigger on. Need to be between 5 to 100.", "example": 6, "format": "int64", "type": "integer" } }, "required": [ "minFuelLevelChangeInPercents" ], "type": "object" }, "TachographActivity": { "description": "Tachograph activity", "properties": { "endTime": { "description": "End time of state in RFC 3339 format.", "example": "2020-01-03T16:04:05Z07:00", "type": "string" }, "isManualEntry": { "description": "A flag indicating whether the activity was manually entered by the driver. If this is `true`, the state cannot be \"UNKNOWN\"", "example": false, "type": "boolean" }, "startTime": { "description": "Start time of state in RFC 3339 format.", "example": "2020-01-02T15:04:05Z07:00", "type": "string" }, "state": { "description": "Tachograph activity state. Valid values: `BREAK/REST`, `WORK`, `AVAILABILITY`, `DRIVING`, `UNKNOWN`.", "enum": [ "BREAK/REST", "WORK", "AVAILABILITY", "DRIVING", "UNKNOWN" ], "type": "string" } }, "type": "object" }, "TachographActivityList": { "description": "List of all driver tachograph activities in a specified time range.", "items": { "$ref": "#/components/schemas/TachographActivity" }, "type": "array" }, "TachographActivityListWrapper": { "properties": { "activity": { "$ref": "#/components/schemas/TachographActivityList" }, "driver": { "$ref": "#/components/schemas/driverTinyResponse" } }, "type": "object" }, "TachographDriverFile": { "description": "Tachograph driver file", "properties": { "cardNumber": { "description": "Tachograph card number associated with the file.", "example": "1000000492436002", "type": "string" }, "createdAtTime": { "description": "Creation time of files in RFC 3339 format. This is either the download time from the tachograph itself (for files downloaded via Samsara VG) or upload time (for files manually uploaded via Samsara UI).", "example": "2020-01-02T15:04:05Z07:00", "type": "string" }, "id": { "description": "ID of the file.", "example": "4aff772c-a7bb-45e6-8e41-6a53e34feb83", "type": "string" }, "url": { "description": "A temporary URL which can be used to download the file. The link can be used multiple times and expires after an hour.", "example": "https://samsara-tachograph-files.s3.us-west-2.amazonaws.com/123/456/789/4aff772c-a7bb-45e6-8e41-6a53e34feb83.ddd", "type": "string" } }, "type": "object" }, "TachographDriverFileData": { "items": { "$ref": "#/components/schemas/TachographDriverFileListWrapper" }, "type": "array" }, "TachographDriverFileList": { "description": "List of all tachograph driver files in a specified time range.", "items": { "$ref": "#/components/schemas/TachographDriverFile" }, "type": "array" }, "TachographDriverFileListWrapper": { "properties": { "driver": { "$ref": "#/components/schemas/driverTinyResponse" }, "files": { "$ref": "#/components/schemas/TachographDriverFileList" } }, "type": "object" }, "TachographDriverFilesResponse": { "description": "List of all driver tachograph files in a specified time range.", "properties": { "data": { "$ref": "#/components/schemas/TachographDriverFileData" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "TachographVehicleFile": { "description": "Tachograph vehicle file", "properties": { "createdAtTime": { "description": "Creation time of files in RFC 3339 format. This is either the download time from the tachograph itself (for files downloaded via Samsara VG) or upload time (for files manually uploaded via Samsara UI).", "example": "2020-01-02T15:04:05Z07:00", "type": "string" }, "id": { "description": "ID of the file.", "example": "4aff772c-a7bb-45e6-8e41-6a53e34feb83", "type": "string" }, "url": { "description": "A temporary URL which can be used to download the file. The link can be used multiple times and expires after an hour.", "example": "https://samsara-tachograph-files.s3.us-west-2.amazonaws.com/123/456/789/4aff772c-a7bb-45e6-8e41-6a53e34feb83.ddd", "type": "string" }, "vehicleIdentificationNumber": { "description": "VIN associated with the vehicle file.", "example": "1000000492436002", "type": "string" } }, "type": "object" }, "TachographVehicleFileData": { "items": { "$ref": "#/components/schemas/TachographVehicleFileListWrapper" }, "type": "array" }, "TachographVehicleFileList": { "description": "List of all tachograph vehicle files in a specified time range.", "items": { "$ref": "#/components/schemas/TachographVehicleFile" }, "type": "array" }, "TachographVehicleFileListWrapper": { "properties": { "files": { "$ref": "#/components/schemas/TachographVehicleFileList" }, "vehicle": { "$ref": "#/components/schemas/vehicleTinyResponse" } }, "type": "object" }, "TachographVehicleFilesResponse": { "description": "List of all vehicle tachograph files in a specified time range.", "properties": { "data": { "$ref": "#/components/schemas/TachographVehicleFileData" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "type": "object" }, "Tag": { "allOf": [ { "$ref": "#/components/schemas/TinyTag" }, { "$ref": "#/components/schemas/Tag_allOf" } ] }, "TagId": { "description": "Unique Samsara ID of this tag.", "example": "342417", "type": "string" }, "TagIds": { "description": "The ids of the tags that the asset should belong to.", "items": { "example": "123", "type": "string" }, "type": "array" }, "TagName": { "description": "Name of this tag.", "example": "California", "maxLength": 191, "minLength": 1, "type": "string" }, "TagResponse": { "description": "A single tag.", "properties": { "data": { "$ref": "#/components/schemas/Tag" } }, "type": "object" }, "Tag_allOf": { "properties": { "addresses": { "description": "The addresses that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObject" }, "type": "array" }, "assets": { "description": "The trailers, unpowered, and powered assets that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObject" }, "type": "array" }, "drivers": { "description": "The drivers that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObject" }, "type": "array" }, "externalIds": { "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "properties": { }, "type": "object" }, "machines": { "description": "The machines that belong to thistag.", "items": { "$ref": "#/components/schemas/TaggedObject" }, "type": "array" }, "parentTag": { "$ref": "#/components/schemas/ParentTag" }, "sensors": { "description": "The sensors that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObject" }, "type": "array" }, "vehicles": { "description": "The vehicles that belong to this tag.", "items": { "$ref": "#/components/schemas/TaggedObject" }, "type": "array" } }, "type": "object" }, "TaggedObject": { "properties": { "id": { "$ref": "#/components/schemas/TaggedObjectId" }, "name": { "$ref": "#/components/schemas/TaggedObjectName" } }, "required": [ "id" ], "type": "object" }, "TaggedObjectId": { "description": "The object ID.", "example": "23502866574", "type": "string" }, "TaggedObjectName": { "description": "The object name.", "example": "Driver Don", "type": "string" }, "TamperingDetectedResponseBody": { "description": "Details specific to Tampering Detected.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "TimeRangeObjectRequestBody": { "description": "A daily time range. If start time of day is greater than end time of day, then the time range applies overnight from the specified day of week into the following day.", "properties": { "daysOfWeek": { "description": "Which days this timezone applies to.", "example": [ "SATURDAY", "MONDAY", "SUNDAY", "TUESDAY" ], "items": { "description": "The day of the week. Valid values: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`", "enum": [ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ], "example": "THURSDAY", "type": "string" }, "type": "array" }, "endTime": { "description": "The time of day at which the time range starts. In 24 hour kitchen clock format.", "example": "20:00", "type": "string" }, "startTime": { "description": "The time of day at which the time range starts. In 24 hour kitchen clock format.", "example": "11:00", "type": "string" }, "timezone": { "description": "The timezone of the time range uses [IANA timezone database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`, `America/New_York`, `Europe/London`, etc.). You can find a mapping of common timezone formats to IANA timezone keys [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).", "example": "America/Los_Angeles", "type": "string" } }, "required": [ "daysOfWeek", "endTime", "startTime", "timezone" ], "type": "object" }, "TimeRangeObjectResponseBody": { "description": "A daily time range. If start time of day is greater than end time of day, then the time range applies overnight from the specified day of week into the following day.", "properties": { "daysOfWeek": { "description": "Which days this timezone applies to.", "example": [ "SATURDAY", "TUESDAY", "SUNDAY" ], "items": { "description": "The day of the week. Valid values: `FRIDAY`, `MONDAY`, `SATURDAY`, `SUNDAY`, `THURSDAY`, `TUESDAY`, `WEDNESDAY`", "enum": [ "FRIDAY", "MONDAY", "SATURDAY", "SUNDAY", "THURSDAY", "TUESDAY", "WEDNESDAY" ], "example": "WEDNESDAY", "type": "string" }, "type": "array" }, "endTime": { "description": "The time of day at which the time range starts. In 24 hour kitchen clock format.", "example": "20:00", "type": "string" }, "startTime": { "description": "The time of day at which the time range starts. In 24 hour kitchen clock format.", "example": "11:00", "type": "string" }, "timezone": { "description": "The timezone of the time range uses [IANA timezone database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`, `America/New_York`, `Europe/London`, etc.). You can find a mapping of common timezone formats to IANA timezone keys [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).", "example": "America/Los_Angeles", "type": "string" } }, "required": [ "daysOfWeek", "endTime", "startTime", "timezone" ], "type": "object" }, "TinyAssetObjectRequestBody": { "description": "Vehicle, trailer or other equipment to be tracked.", "properties": { "assetId": { "description": "ID of the asset.", "example": "12443", "type": "string" }, "assetType": { "default": "uncategorized", "description": "The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "trailer", "type": "string" } }, "required": [ "assetId", "assetType" ], "type": "object" }, "TinyAssetObjectResponseBody": { "description": "Vehicle, trailer or other equipment to be tracked.", "properties": { "assetId": { "description": "ID of the asset.", "example": "12443", "type": "string" }, "assetType": { "default": "uncategorized", "description": "The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "trailer", "type": "string" } }, "required": [ "assetId", "assetType" ], "type": "object" }, "TinyDriverObjectRequestBody": { "description": "The driver of a vehicle.", "properties": { "driverId": { "description": "ID of the driver.", "example": "12434", "type": "string" } }, "required": [ "driverId" ], "type": "object" }, "TinyDriverObjectResponseBody": { "description": "The driver of a vehicle.", "properties": { "driverId": { "description": "ID of the driver.", "example": "12434", "type": "string" } }, "required": [ "driverId" ], "type": "object" }, "TinyTag": { "properties": { "id": { "$ref": "#/components/schemas/TagId" }, "name": { "$ref": "#/components/schemas/TagName" }, "parentTagId": { "$ref": "#/components/schemas/ParentTagId" } }, "type": "object" }, "TinyWidgetObjectRequestBody": { "description": "Widget to be tracked.", "properties": { "widgetId": { "description": "ID of the widget.", "example": "12434", "type": "string" } }, "required": [ "widgetId" ], "type": "object" }, "TinyWidgetObjectResponseBody": { "description": "Widget to be tracked.", "properties": { "widgetId": { "description": "ID of the widget.", "example": "12434", "type": "string" } }, "required": [ "widgetId" ], "type": "object" }, "TireFaultCodeDetailsObjectRequestBody": { "description": "Details specific to Tire Fault Code. At least one fault code or fault code group must be selected.", "properties": { "hasCautionaryTireFaultCodes": { "description": "If true then alert over pressure, under pressure, across axle fault, or leak detected fault codes. Defaults to false.", "example": true, "type": "boolean" }, "hasCriticalTireFaultCodes": { "description": "If true then alert over temperature or extreme pressure over or under fault codes. Defaults to false.", "example": true, "type": "boolean" }, "manufacturer": { "description": "The tire manufacturer. Valid values: `MANUFACTURER_BENDIX`, `MANUFACTURER_CONTINENTAL`, `MANUFACTURER_DORAN`, `MANUFACTURER_HENDRICKSON`, `MANUFACTURER_INVALID`, `MANUFACTURER_PRESSURE_PRO`, `MANUFACTURER_UNIVERSAL_J1939`, `MANUFACTURER_UNIVERSAL_R141`", "enum": [ "MANUFACTURER_BENDIX", "MANUFACTURER_CONTINENTAL", "MANUFACTURER_DORAN", "MANUFACTURER_HENDRICKSON", "MANUFACTURER_INVALID", "MANUFACTURER_PRESSURE_PRO", "MANUFACTURER_UNIVERSAL_J1939", "MANUFACTURER_UNIVERSAL_R141" ], "example": "MANUFACTURER_BENDIX", "type": "string" }, "specificTireFaultCodes": { "description": "The list of specific tire fault codes to be alerted on.", "example": [ "TIRE_ALERT_ACROSS_AXLE_FAULT", "TIRE_ALERT_ACROSS_AXLE_FAULT", "TIRE_ALERT_ACROSS_AXLE_FAULT", "TIRE_ALERT_ACROSS_AXLE_FAULT" ], "items": { "description": "The specific tire fault codes. Valid values: `TIRE_ALERT_ACROSS_AXLE_FAULT`, `TIRE_ALERT_EXTREME_OVER_PRESSURE`, `TIRE_ALERT_EXTREME_UNDER_PRESSURE`, `TIRE_ALERT_INVALID`, `TIRE_ALERT_LEAK_DETECTED`, `TIRE_ALERT_OVER_PRESSURE`, `TIRE_ALERT_OVER_TEMPERATURE`, `TIRE_ALERT_SENSOR_DEFECT`, `TIRE_ALERT_SENSOR_LOOSE_OR_FLIPPED`, `TIRE_ALERT_SENSOR_LOW_BATTERY`, `TIRE_ALERT_SENSOR_MISSING`, `TIRE_ALERT_UNDER_PRESSURE`", "enum": [ "TIRE_ALERT_ACROSS_AXLE_FAULT", "TIRE_ALERT_EXTREME_OVER_PRESSURE", "TIRE_ALERT_EXTREME_UNDER_PRESSURE", "TIRE_ALERT_INVALID", "TIRE_ALERT_LEAK_DETECTED", "TIRE_ALERT_OVER_PRESSURE", "TIRE_ALERT_OVER_TEMPERATURE", "TIRE_ALERT_SENSOR_DEFECT", "TIRE_ALERT_SENSOR_LOOSE_OR_FLIPPED", "TIRE_ALERT_SENSOR_LOW_BATTERY", "TIRE_ALERT_SENSOR_MISSING", "TIRE_ALERT_UNDER_PRESSURE" ], "example": "TIRE_ALERT_ACROSS_AXLE_FAULT", "type": "string" }, "type": "array" } }, "required": [ "manufacturer" ], "type": "object" }, "TireFaultCodeDetailsObjectResponseBody": { "description": "Details specific to Tire Fault Code. At least one fault code or fault code group must be selected.", "properties": { "hasCautionaryTireFaultCodes": { "description": "If true then alert over pressure, under pressure, across axle fault, or leak detected fault codes. Defaults to false.", "example": true, "type": "boolean" }, "hasCriticalTireFaultCodes": { "description": "If true then alert over temperature or extreme pressure over or under fault codes. Defaults to false.", "example": true, "type": "boolean" }, "manufacturer": { "description": "The tire manufacturer. Valid values: `MANUFACTURER_BENDIX`, `MANUFACTURER_CONTINENTAL`, `MANUFACTURER_DORAN`, `MANUFACTURER_HENDRICKSON`, `MANUFACTURER_INVALID`, `MANUFACTURER_PRESSURE_PRO`, `MANUFACTURER_UNIVERSAL_J1939`, `MANUFACTURER_UNIVERSAL_R141`", "enum": [ "MANUFACTURER_BENDIX", "MANUFACTURER_CONTINENTAL", "MANUFACTURER_DORAN", "MANUFACTURER_HENDRICKSON", "MANUFACTURER_INVALID", "MANUFACTURER_PRESSURE_PRO", "MANUFACTURER_UNIVERSAL_J1939", "MANUFACTURER_UNIVERSAL_R141" ], "example": "MANUFACTURER_BENDIX", "type": "string" }, "specificTireFaultCodes": { "description": "The list of specific tire fault codes to be alerted on.", "example": [ "TIRE_ALERT_ACROSS_AXLE_FAULT", "TIRE_ALERT_ACROSS_AXLE_FAULT", "TIRE_ALERT_ACROSS_AXLE_FAULT" ], "items": { "description": "The specific tire fault codes. Valid values: `TIRE_ALERT_ACROSS_AXLE_FAULT`, `TIRE_ALERT_EXTREME_OVER_PRESSURE`, `TIRE_ALERT_EXTREME_UNDER_PRESSURE`, `TIRE_ALERT_INVALID`, `TIRE_ALERT_LEAK_DETECTED`, `TIRE_ALERT_OVER_PRESSURE`, `TIRE_ALERT_OVER_TEMPERATURE`, `TIRE_ALERT_SENSOR_DEFECT`, `TIRE_ALERT_SENSOR_LOOSE_OR_FLIPPED`, `TIRE_ALERT_SENSOR_LOW_BATTERY`, `TIRE_ALERT_SENSOR_MISSING`, `TIRE_ALERT_UNDER_PRESSURE`", "enum": [ "TIRE_ALERT_ACROSS_AXLE_FAULT", "TIRE_ALERT_EXTREME_OVER_PRESSURE", "TIRE_ALERT_EXTREME_UNDER_PRESSURE", "TIRE_ALERT_INVALID", "TIRE_ALERT_LEAK_DETECTED", "TIRE_ALERT_OVER_PRESSURE", "TIRE_ALERT_OVER_TEMPERATURE", "TIRE_ALERT_SENSOR_DEFECT", "TIRE_ALERT_SENSOR_LOOSE_OR_FLIPPED", "TIRE_ALERT_SENSOR_LOW_BATTERY", "TIRE_ALERT_SENSOR_MISSING", "TIRE_ALERT_UNDER_PRESSURE" ], "example": "TIRE_ALERT_ACROSS_AXLE_FAULT", "type": "string" }, "type": "array" } }, "required": [ "manufacturer" ], "type": "object" }, "TireFaultsResponseBody": { "description": "Details specific to Tire Faults.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "TotalBrakeEventCount": { "description": "Total number of brake events.", "type": "number" }, "TrailerAssignmentsCreateDriverTrailerAssignmentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody": { "description": "Create a new driver-trailer assignment", "properties": { "driverId": { "description": "ID of the driver. This can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the driver.", "example": "494123", "type": "string" }, "startTime": { "description": "The start time in RFC 3339 format. The time needs to be current or within the past 7 days. Defaults to now if not provided", "example": "2019-06-13T19:08:25Z", "type": "string" }, "trailerId": { "description": "ID of the trailer. This can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the trailer.", "example": "12345", "type": "string" } }, "required": [ "driverId", "trailerId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PostDriverTrailerAssignmentsResponseBodyResponseBody" } }, "required": [ "data" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsCreateDriverTrailerAssignmentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody": { "properties": { "data": { "description": "List of driver trailer assignment objects and their respective driver and trailer info.", "items": { "$ref": "#/components/schemas/GetDriverTrailerAssignmentsResponseBodyResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsGetDriverTrailerAssignmentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody": { "description": "Update a new driver-trailer assignment", "properties": { "endTime": { "description": "The end time in RFC 3339 format. The end time should not be in the future", "example": "2019-06-13T19:08:25Z", "type": "string" } }, "required": [ "endTime" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/PatchDriverTrailerAssignmentsResponseBodyResponseBody" } }, "required": [ "data" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerAssignmentsUpdateDriverTrailerAssignmentUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerDvirObjectResponseBody": { "description": "A trailer object", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the trailer", "example": "494123", "type": "string" } }, "type": "object" }, "TrailerGoaGatewayTinyResponseResponseBody": { "description": "A minified gateway object. This field will be omitted if the trailer does not have a gateway installed.", "properties": { "model": { "description": "The model of the gateway installed on the asset. Valid values: `AG15`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG41`, `AG41EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`, `IG15`, `IG21`, `IG41`, `IG61`, `SG1`, `SG1B`, `SG1G`, `SG1G32`, `SG1x`, `VG32`, `VG33`, `VG34`, `VG34EU`, `VG34FN`, `VG34M`, `VG54ATT`, `VG54EU`, `VG54FN`, `VG54NA`, `VG54NAE`, `VG54NAH`, `VG55EU`, `VG55FN`, `VG55NA`", "enum": [ "AG15", "AG24", "AG24EU", "AG26", "AG26EU", "AG41", "AG41EU", "AG45", "AG45EU", "AG46", "AG46EU", "AG46P", "AG46PEU", "AG51", "AG51EU", "AG52", "AG52EU", "AG53", "AG53EU", "IG15", "IG21", "IG41", "IG61", "SG1", "SG1B", "SG1G", "SG1G32", "SG1x", "VG32", "VG33", "VG34", "VG34EU", "VG34FN", "VG34M", "VG54ATT", "VG54EU", "VG54FN", "VG54NA", "VG54NAE", "VG54NAH", "VG55EU", "VG55FN", "VG55NA" ], "example": "VG34", "type": "string" }, "serial": { "description": "The serial number of the gateway installed on the asset.", "example": "GFRV-43N-VGX", "type": "string" } }, "required": [ "model", "serial" ], "type": "object" }, "TrailerObjectResponseBody": { "description": "A trailer asset object associate with the assigment.", "properties": { "trailerId": { "description": "Samsara ID of the trailer.", "example": "494123", "type": "string" } }, "required": [ "trailerId" ], "type": "object" }, "TrailerResponseObjectResponseBody": { "properties": { "enabledForMobile": { "description": "Indicates if the trailer is visible on the Samsara mobile apps.", "example": true, "type": "boolean" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed.", "example": "494123", "type": "string" }, "installedGateway": { "$ref": "#/components/schemas/TrailerGoaGatewayTinyResponseResponseBody" }, "licensePlate": { "description": "The license plate of the Trailer. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "7TYP290", "maxLength": 12, "type": "string" }, "name": { "description": "The human-readable name of the Trailer. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Trailer-123", "type": "string" }, "notes": { "description": "These are generic notes about the Trailer. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are my trailer notes", "maxLength": 255, "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Trailer.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" }, "trailerSerialNumber": { "description": "The serial number of the trailer.", "example": "8V8WD530FLN016251", "type": "string" } }, "required": [ "id" ], "type": "object" }, "TrailerStatDecorationResponseBody": { "description": "Decorated values for the primary trailer stat datapoints.", "properties": { "carrierReeferState": { "$ref": "#/components/schemas/TrailerStatReeferStateTypeResponseBody" }, "gps": { "$ref": "#/components/schemas/TrailerStatGpsTypeResponseBody" }, "gpsOdometerMeters": { "$ref": "#/components/schemas/TrailerStatGpsOdometerMetersTypeResponseBody" }, "reeferAlarms": { "$ref": "#/components/schemas/TrailerStatReeferAlarmTypeResponseBody" }, "reeferAmbientAirTemperatureMilliC": { "$ref": "#/components/schemas/TrailerStatReeferAmbientAirTemperatureMilliCTypeResponseBody" }, "reeferDoorStateZone1": { "$ref": "#/components/schemas/TrailerStatReeferDoorStateZone1TypeResponseBody" }, "reeferDoorStateZone2": { "$ref": "#/components/schemas/TrailerStatReeferDoorStateZone2TypeResponseBody" }, "reeferDoorStateZone3": { "$ref": "#/components/schemas/TrailerStatReeferDoorStateZone3TypeResponseBody" }, "reeferFuelPercent": { "$ref": "#/components/schemas/TrailerStatReeferFuelPercentTypeResponseBody" }, "reeferObdEngineSeconds": { "$ref": "#/components/schemas/TrailerStatReeferObdEngineSecondsTypeResponseBody" }, "reeferReturnAirTemperatureMilliCZone1": { "$ref": "#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone1TypeResponseBody" }, "reeferReturnAirTemperatureMilliCZone2": { "$ref": "#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone2TypeResponseBody" }, "reeferReturnAirTemperatureMilliCZone3": { "$ref": "#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone3TypeResponseBody" }, "reeferRunMode": { "$ref": "#/components/schemas/TrailerStatReeferRunModeTypeResponseBody" }, "reeferSetPointTemperatureMilliCZone1": { "$ref": "#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone1TypeResponseBody" }, "reeferSetPointTemperatureMilliCZone2": { "$ref": "#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone2TypeResponseBody" }, "reeferSetPointTemperatureMilliCZone3": { "$ref": "#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone3TypeResponseBody" }, "reeferStateZone1": { "$ref": "#/components/schemas/TrailerStatReeferStateZone1TypeResponseBody" }, "reeferStateZone2": { "$ref": "#/components/schemas/TrailerStatReeferStateZone2TypeResponseBody" }, "reeferStateZone3": { "$ref": "#/components/schemas/TrailerStatReeferStateZone3TypeResponseBody" }, "reeferSupplyAirTemperatureMilliCZone1": { "$ref": "#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone1TypeResponseBody" }, "reeferSupplyAirTemperatureMilliCZone2": { "$ref": "#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone2TypeResponseBody" }, "reeferSupplyAirTemperatureMilliCZone3": { "$ref": "#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone3TypeResponseBody" } }, "type": "object" }, "TrailerStatGpsOdometerMetersTypeResponseBody": { "description": "Trailer GPS odometer event.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Number of meters the trailer has traveled according to the GPS calculations and the manually specified odometer reading.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatGpsOdometerMetersWithDecorationsTypeResponseBody": { "description": "Trailer GPS odometer event.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Number of meters the trailer has traveled according to the GPS calculations and the manually specified odometer reading.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatGpsTypeResponseBody": { "description": "GPS location data for the trailer.", "properties": { "headingDegrees": { "description": "Heading of the trailer in degrees.", "example": 5.478981605182468e+18, "format": "int64", "type": "integer" }, "latitude": { "description": "GPS latitude represented in degrees.", "example": 0.955367680792097, "format": "double", "type": "number" }, "longitude": { "description": "GPS longitude represented in degrees.", "example": 0.154296488212264, "format": "double", "type": "number" }, "reverseGeo": { "$ref": "#/components/schemas/ReverseGeoObjectResponseBody" }, "speedMilesPerHour": { "description": "GPS speed of the trailer in miles per hour.", "example": 6.626263886997561e+18, "format": "int64", "type": "integer" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" } }, "required": [ "latitude", "longitude", "time" ], "type": "object" }, "TrailerStatGpsWithDecorationsTypeResponseBody": { "description": "GPS location data for the trailer.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "headingDegrees": { "description": "Heading of the trailer in degrees.", "example": 7.952863434806629e+18, "format": "int64", "type": "integer" }, "latitude": { "description": "GPS latitude represented in degrees.", "example": 0.149734961635591, "format": "double", "type": "number" }, "longitude": { "description": "GPS longitude represented in degrees.", "example": 0.0903577794977098, "format": "double", "type": "number" }, "reverseGeo": { "$ref": "#/components/schemas/ReverseGeoObjectResponseBody" }, "speedMilesPerHour": { "description": "GPS speed of the trailer in miles per hour.", "example": 7.073647433567555e+18, "format": "int64", "type": "integer" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" } }, "required": [ "latitude", "longitude", "time" ], "type": "object" }, "TrailerStatReeferAlarmResponseBody": { "properties": { "alarmCode": { "description": "The ID of the alarm.", "example": "3", "type": "string" }, "description": { "description": "The description of the alarm.", "example": "Test alarm", "type": "string" }, "operatorAction": { "description": "The recommended operator action.", "example": "Manually disable alarm", "type": "string" }, "severity": { "description": "The severity of the alarm. `1`: Ok to run, `2`: Check as specified, `3`: Take immediate action.", "example": 6.644289420805649e+18, "format": "int64", "type": "integer" } }, "required": [ "alarmCode", "description", "operatorAction", "severity" ], "type": "object" }, "TrailerStatReeferAlarmTypeResponseBody": { "description": "Alarms that have been emitted by the reefer.", "properties": { "alarms": { "description": "The alarms reported by the reefer.", "items": { "$ref": "#/components/schemas/TrailerStatReeferAlarmResponseBody" }, "type": "array" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" } }, "required": [ "alarms", "time" ], "type": "object" }, "TrailerStatReeferAlarmWithDecorationsTypeResponseBody": { "description": "Alarms that have been emitted by the reefer.", "properties": { "alarms": { "description": "The alarms reported by the reefer.", "items": { "$ref": "#/components/schemas/TrailerStatReeferAlarmResponseBody" }, "type": "array" }, "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" } }, "required": [ "alarms", "time" ], "type": "object" }, "TrailerStatReeferAmbientAirTemperatureMilliCTypeResponseBody": { "description": "Reefer ambient air temperature reading.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The ambient air temperature reading of the reefer in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferAmbientAirTemperatureWithDecorationsTypeResponseBody": { "description": "Reefer ambient air temperature reading.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The ambient air temperature reading of the reefer in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferDoorStateZone1TypeResponseBody": { "description": "The door state of the reefer.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The door state of zone 2 of the reefer. Valid values: `open`, `closed`", "enum": [ "open", "closed" ], "example": "closed", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferDoorStateZone1WithDecorationsTypeResponseBody": { "description": "Door stats that have been emitted by the reefer.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The door state of zone 2 of the reefer. Valid values: `open`, `closed`", "enum": [ "open", "closed" ], "example": "closed", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferDoorStateZone2TypeResponseBody": { "description": "The door state of the reefer.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The door state of zone 2 of the reefer. Valid values: `open`, `closed`", "enum": [ "open", "closed" ], "example": "closed", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferDoorStateZone2WithDecorationsTypeResponseBody": { "description": "Door stats that have been emitted by the reefer.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The door state of zone 2 of the reefer. Valid values: `open`, `closed`", "enum": [ "open", "closed" ], "example": "closed", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferDoorStateZone3TypeResponseBody": { "description": "The door state of the reefer.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The door state of zone 2 of the reefer. Valid values: `open`, `closed`", "enum": [ "open", "closed" ], "example": "closed", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferDoorStateZone3WithDecorationsTypeResponseBody": { "description": "Door stats that have been emitted by the reefer.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The door state of zone 2 of the reefer. Valid values: `open`, `closed`", "enum": [ "open", "closed" ], "example": "closed", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferFuelPercentTypeResponseBody": { "description": "The fuel percentage of the reefer.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The fuel level in percentage points (e.g. `99`, `50`, etc).", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferFuelPercentWithDecorationsTypeResponseBody": { "description": "The fuel percentage of the reefer.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The fuel level in percentage points (e.g. `99`, `50`, etc).", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferObdEngineSecondsTypeResponseBody": { "description": "Reefer onboard engine seconds reading.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The number of seconds the reefer has been on according to the onboard diagnostics.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferObdEngineSecondsWithDecorationsTypeResponseBody": { "description": "Reefer onboard engine seconds reading.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The number of seconds the reefer has been on according to the onboard diagnostics.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferReturnAirTemperatureMilliCZone1TypeResponseBody": { "description": "Return air temperature of zone 1 of the reefer. This is the temperature of the air as it enters the cooling unit.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The return air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferReturnAirTemperatureMilliCZone1WithDecorationsTypeResponseBody": { "description": "Return air temperature of zone 1 of the reefer. This is the temperature of the air as it enters the cooling unit.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The return air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferReturnAirTemperatureMilliCZone2TypeResponseBody": { "description": "Return air temperature of zone 2 of the reefer. This is the temperature of the air as it enters the cooling unit.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The return air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferReturnAirTemperatureMilliCZone2WithDecorationsTypeResponseBody": { "description": "Return air temperature of zone 2 of the reefer. This is the temperature of the air as it enters the cooling unit.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The return air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferReturnAirTemperatureMilliCZone3TypeResponseBody": { "description": "Return air temperature of zone 3 of the reefer. This is the temperature of the air as it enters the cooling unit.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The return air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferReturnAirTemperatureMilliCZone3WithDecorationsTypeResponseBody": { "description": "Return air temperature of zone 3 of the reefer. This is the temperature of the air as it enters the cooling unit.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The return air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferRunModeTypeResponseBody": { "description": "The run mode of the reefer.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The operational mode of the reefer.", "example": "`Start/Stop`,`Continuous`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferRunModeWithDecorationsTypeResponseBody": { "description": "The run mode of the reefer.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The operational mode of the reefer.", "example": "`Start/Stop`,`Continuous`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSetPointTemperatureMilliCZone1TypeResponseBody": { "description": "Set point temperature of zone 1 of the reefer.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The set point temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSetPointTemperatureMilliCZone1WithDecorationsTypeResponseBody": { "description": "Set point temperature of zone 1 of the reefer.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The set point temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSetPointTemperatureMilliCZone2TypeResponseBody": { "description": "Set point temperature of zone 2 of the reefer.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The set point temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSetPointTemperatureMilliCZone2WithDecorationsTypeResponseBody": { "description": "Set point temperature of zone 2 of the reefer.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The set point temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSetPointTemperatureMilliCZone3TypeResponseBody": { "description": "Set point temperature of zone 3 of the reefer.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The set point temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSetPointTemperatureMilliCZone3WithDecorationsTypeResponseBody": { "description": "Set point temperature of zone 3 of the reefer.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The set point temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferStateTypeResponseBody": { "description": "Reefer state event.", "properties": { "substateValue": { "description": "The substate of the multizone carrier reefer, if available.", "example": "`Pretrip`, `Defrost`", "type": "string" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The overall state of the multizone carrier reefer.", "example": "`Off`, `On`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferStateWithDecorationsTypeResponseBody": { "description": "Reefer state event.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "substateValue": { "description": "The substate of the multizone carrier reefer, if available.", "example": "`Pretrip`, `Defrost`", "type": "string" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The overall state of the multizone carrier reefer.", "example": "`Off`, `On`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferStateZone1TypeResponseBody": { "description": "Reefer state event.", "properties": { "substateValue": { "description": "The substate zone 1 of the reefer, if available.", "example": "`Pretrip`, `Defrost`", "type": "string" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The state zone 1 of the reefer.", "example": "`Off`, `On`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferStateZone1WithDecorationsTypeResponseBody": { "description": "Reefer state event.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "substateValue": { "description": "The substate zone 1 of the reefer, if available.", "example": "`Pretrip`, `Defrost`", "type": "string" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The state zone 1 of the reefer.", "example": "`Off`, `On`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferStateZone2TypeResponseBody": { "description": "Reefer state event.", "properties": { "substateValue": { "description": "The substate zone 2 of the reefer, if available.", "example": "`Pretrip`, `Defrost`", "type": "string" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The state zone 2 of the reefer.", "example": "`Off`, `On`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferStateZone2WithDecorationsTypeResponseBody": { "description": "Reefer state event.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "substateValue": { "description": "The substate zone 2 of the reefer, if available.", "example": "`Pretrip`, `Defrost`", "type": "string" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The state zone 2 of the reefer.", "example": "`Off`, `On`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferStateZone3TypeResponseBody": { "description": "Reefer state event.", "properties": { "substateValue": { "description": "The substate zone 3 of the reefer, if available.", "example": "`Pretrip`, `Defrost`", "type": "string" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The state zone 3 of the reefer.", "example": "`Off`, `On`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferStateZone3WithDecorationsTypeResponseBody": { "description": "Reefer state event.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "substateValue": { "description": "The substate zone 3 of the reefer, if available.", "example": "`Pretrip`, `Defrost`", "type": "string" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The state zone 3 of the reefer.", "example": "`Off`, `On`", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSupplyAirTemperatureMilliCZone1TypeResponseBody": { "description": "Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The supply or discharge air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSupplyAirTemperatureMilliCZone1WithDecorationsTypeResponseBody": { "description": "Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The supply or discharge air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSupplyAirTemperatureMilliCZone2TypeResponseBody": { "description": "Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The supply or discharge air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSupplyAirTemperatureMilliCZone2WithDecorationsTypeResponseBody": { "description": "Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The supply or discharge air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSupplyAirTemperatureMilliCZone3TypeResponseBody": { "description": "Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The supply or discharge air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatReeferSupplyAirTemperatureMilliCZone3WithDecorationsTypeResponseBody": { "description": "Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.", "properties": { "decorations": { "$ref": "#/components/schemas/TrailerStatDecorationResponseBody" }, "time": { "description": "UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "The supply or discharge air temperature reading in millidegree Celsius.", "example": 50, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedResponseBody": { "properties": { "data": { "description": "List of trailers and their stats", "items": { "$ref": "#/components/schemas/TrailerStatsObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsFeedUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryResponseBody": { "properties": { "data": { "description": "List of trailers and their stats", "items": { "$ref": "#/components/schemas/TrailerStatsObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsHistoryUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotResponseBody": { "properties": { "data": { "description": "List of trailers and their stats", "items": { "$ref": "#/components/schemas/TrailerStatsSnapshotObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsGetTrailerStatsSnapshotUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailerStatsObjectResponseBody": { "description": "A trailer and its stats", "properties": { "carrierReeferState": { "description": "A list of engine state points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferStateWithDecorationsTypeResponseBody" }, "type": "array" }, "gps": { "description": "A list of GPS points.", "items": { "$ref": "#/components/schemas/TrailerStatGpsWithDecorationsTypeResponseBody" }, "type": "array" }, "gpsOdometerMeters": { "description": "A list of odometer points.", "items": { "$ref": "#/components/schemas/TrailerStatGpsOdometerMetersWithDecorationsTypeResponseBody" }, "type": "array" }, "id": { "description": "ID of the trailer.", "example": "1234", "type": "string" }, "name": { "description": "Name of the vehicle.", "example": "Trailer-123", "type": "string" }, "reeferAlarms": { "description": "A list of reefer alarm points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferAlarmWithDecorationsTypeResponseBody" }, "type": "array" }, "reeferAmbientAirTemperatureMilliC": { "description": "A list of ambient air temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferAmbientAirTemperatureWithDecorationsTypeResponseBody" }, "type": "array" }, "reeferDoorStateZone1": { "description": "A list of door state points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferDoorStateZone1WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferDoorStateZone2": { "description": "A list of door state points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferDoorStateZone2WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferDoorStateZone3": { "description": "A list of door state points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferDoorStateZone3WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferFuelPercent": { "description": "A list of fuel percent points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferFuelPercentWithDecorationsTypeResponseBody" }, "type": "array" }, "reeferObdEngineSeconds": { "description": "A list of engine second points", "items": { "$ref": "#/components/schemas/TrailerStatReeferObdEngineSecondsWithDecorationsTypeResponseBody" }, "type": "array" }, "reeferReturnAirTemperatureMilliCZone1": { "description": "A list of return air temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone1WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferReturnAirTemperatureMilliCZone2": { "description": "A list of return air temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone2WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferReturnAirTemperatureMilliCZone3": { "description": "A list of return air temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone3WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferRunMode": { "description": "A list of run mode points", "items": { "$ref": "#/components/schemas/TrailerStatReeferRunModeWithDecorationsTypeResponseBody" }, "type": "array" }, "reeferSetPointTemperatureMilliCZone1": { "description": "A list of set point temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone1WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferSetPointTemperatureMilliCZone2": { "description": "A list of set point temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone2WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferSetPointTemperatureMilliCZone3": { "description": "A list of set point temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone3WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferStateZone1": { "description": "A list of engine state points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferStateZone1WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferStateZone2": { "description": "A list of engine state points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferStateZone2WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferStateZone3": { "description": "A list of engine state points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferStateZone3WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferSupplyAirTemperatureMilliCZone1": { "description": "A list of supply air temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone1WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferSupplyAirTemperatureMilliCZone2": { "description": "A list of supply air temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone2WithDecorationsTypeResponseBody" }, "type": "array" }, "reeferSupplyAirTemperatureMilliCZone3": { "description": "A list of supply air temperature points.", "items": { "$ref": "#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone3WithDecorationsTypeResponseBody" }, "type": "array" } }, "required": [ "id", "name" ], "type": "object" }, "TrailerStatsSnapshotObjectResponseBody": { "description": "A trailer and its stats", "properties": { "carrierReeferState": { "$ref": "#/components/schemas/TrailerStatReeferStateTypeResponseBody" }, "gps": { "$ref": "#/components/schemas/TrailerStatGpsTypeResponseBody" }, "gpsOdometerMeters": { "$ref": "#/components/schemas/TrailerStatGpsOdometerMetersTypeResponseBody" }, "id": { "description": "ID of the trailer.", "example": "1234", "type": "string" }, "name": { "description": "Name of the vehicle.", "example": "Trailer-123", "type": "string" }, "reeferAlarms": { "$ref": "#/components/schemas/TrailerStatReeferAlarmTypeResponseBody" }, "reeferAmbientAirTemperatureMilliC": { "$ref": "#/components/schemas/TrailerStatReeferAmbientAirTemperatureMilliCTypeResponseBody" }, "reeferDoorStateZone1": { "$ref": "#/components/schemas/TrailerStatReeferDoorStateZone1TypeResponseBody" }, "reeferDoorStateZone2": { "$ref": "#/components/schemas/TrailerStatReeferDoorStateZone2TypeResponseBody" }, "reeferDoorStateZone3": { "$ref": "#/components/schemas/TrailerStatReeferDoorStateZone3TypeResponseBody" }, "reeferFuelPercent": { "$ref": "#/components/schemas/TrailerStatReeferFuelPercentTypeResponseBody" }, "reeferObdEngineSeconds": { "$ref": "#/components/schemas/TrailerStatReeferObdEngineSecondsTypeResponseBody" }, "reeferReturnAirTemperatureMilliCZone1": { "$ref": "#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone1TypeResponseBody" }, "reeferReturnAirTemperatureMilliCZone2": { "$ref": "#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone2TypeResponseBody" }, "reeferReturnAirTemperatureMilliCZone3": { "$ref": "#/components/schemas/TrailerStatReeferReturnAirTemperatureMilliCZone3TypeResponseBody" }, "reeferRunMode": { "$ref": "#/components/schemas/TrailerStatReeferRunModeTypeResponseBody" }, "reeferSetPointTemperatureMilliCZone1": { "$ref": "#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone1TypeResponseBody" }, "reeferSetPointTemperatureMilliCZone2": { "$ref": "#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone2TypeResponseBody" }, "reeferSetPointTemperatureMilliCZone3": { "$ref": "#/components/schemas/TrailerStatReeferSetPointTemperatureMilliCZone3TypeResponseBody" }, "reeferStateZone1": { "$ref": "#/components/schemas/TrailerStatReeferStateZone1TypeResponseBody" }, "reeferStateZone2": { "$ref": "#/components/schemas/TrailerStatReeferStateZone2TypeResponseBody" }, "reeferStateZone3": { "$ref": "#/components/schemas/TrailerStatReeferStateZone3TypeResponseBody" }, "reeferSupplyAirTemperatureMilliCZone1": { "$ref": "#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone1TypeResponseBody" }, "reeferSupplyAirTemperatureMilliCZone2": { "$ref": "#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone2TypeResponseBody" }, "reeferSupplyAirTemperatureMilliCZone3": { "$ref": "#/components/schemas/TrailerStatReeferSupplyAirTemperatureMilliCZone3TypeResponseBody" } }, "required": [ "id", "name" ], "type": "object" }, "TrailerWithAttributesResponseObjectResponseBody": { "properties": { "attributes": { "description": "List of attributes associated with the entity", "items": { "$ref": "#/components/schemas/GoaAttributeTinyResponseBody" }, "type": "array" }, "enabledForMobile": { "description": "Indicates if the trailer is visible on the Samsara mobile apps.", "example": true, "type": "boolean" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The unique Samsara ID of the Trailer. This is automatically generated when the Trailer object is created. It cannot be changed.", "example": "494123", "type": "string" }, "installedGateway": { "$ref": "#/components/schemas/TrailerGoaGatewayTinyResponseResponseBody" }, "licensePlate": { "description": "The license plate of the Trailer. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "7TYP290", "maxLength": 12, "type": "string" }, "name": { "description": "The human-readable name of the Trailer. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Trailer-123", "type": "string" }, "notes": { "description": "These are generic notes about the Trailer. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are my trailer notes", "maxLength": 255, "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Trailer.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" }, "trailerSerialNumber": { "description": "The serial number of the trailer.", "example": "8V8WD530FLN016251", "type": "string" } }, "required": [ "id" ], "type": "object" }, "TrailersCreateTrailerBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersCreateTrailerBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersCreateTrailerGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersCreateTrailerInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersCreateTrailerMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersCreateTrailerNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersCreateTrailerNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersCreateTrailerRequestBody": { "properties": { "attributes": { "description": "A list of attributes to assign to the trailer.", "items": { "$ref": "#/components/schemas/GoaAttributeTinyRequestBody" }, "type": "array" }, "enabledForMobile": { "description": "Indicates if the trailer is visible on the Samsara mobile apps.", "example": true, "type": "boolean" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "licensePlate": { "description": "The license plate of the Trailer. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "7TYP290", "maxLength": 12, "type": "string" }, "name": { "description": "The human-readable name of the Trailer. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Trailer-123", "type": "string" }, "notes": { "description": "These are generic notes about the Trailer. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are my trailer notes", "maxLength": 255, "type": "string" }, "tagIds": { "description": "An array of IDs of tags to associate with this trailer. If your access to the API is scoped by one or more tags, this field is required to pass in.", "example": [ "Delectus alias molestiae.", "Nam ut.", "Eum ut qui aut voluptas soluta.", "Quia corrupti." ], "items": { "example": "Nihil nemo et delectus ab est a.", "type": "string" }, "type": "array" }, "trailerSerialNumber": { "description": "The serial number of the trailer.", "example": "8V8WD530FLN016251", "type": "string" } }, "required": [ "name" ], "type": "object" }, "TrailersCreateTrailerResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/TrailerWithAttributesResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "TrailersCreateTrailerServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersCreateTrailerTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersCreateTrailerUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersDeleteTrailerUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/TrailerWithAttributesResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "TrailersGetTrailerServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersGetTrailerUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersResponseBody": { "properties": { "data": { "description": "List of trailer objects.", "items": { "$ref": "#/components/schemas/TrailerResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "TrailersListTrailersServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersListTrailersUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerRequestBody": { "properties": { "attributes": { "description": "A list of attributes to assign to the trailer.", "items": { "$ref": "#/components/schemas/GoaAttributeTinyRequestBody" }, "type": "array" }, "enabledForMobile": { "description": "Indicates if the trailer is visible on the Samsara mobile apps.", "example": true, "type": "boolean" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "licensePlate": { "description": "The license plate of the Trailer. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "7TYP290", "maxLength": 12, "type": "string" }, "name": { "description": "The human-readable name of the Trailer. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Trailer-123", "type": "string" }, "notes": { "description": "These are generic notes about the Trailer. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are my trailer notes", "maxLength": 255, "type": "string" }, "odometerMeters": { "description": "When you provide a manual odometer override, Samsara will begin updating a trailer's odometer using GPS distance traveled since this override was set. Only applies to trailers installed with Samsara gateways.", "example": 1234, "format": "int64", "type": "integer" }, "tagIds": { "description": "An array of IDs of tags to associate with this trailer. If your access to the API is scoped by one or more tags, this field is required to pass in.", "example": [ "Qui ad et et non.", "Et numquam ut.", "Qui eligendi vel ab ut." ], "items": { "example": "Ratione consequatur delectus dolorum ut.", "type": "string" }, "type": "array" }, "trailerSerialNumber": { "description": "The serial number of the trailer.", "example": "8V8WD530FLN016251", "type": "string" } }, "type": "object" }, "TrailersUpdateTrailerResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/TrailerWithAttributesResponseObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "TrailersUpdateTrailerServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrailersUpdateTrailerUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentNearDueDateTriggerAssignmentGroupObjectRequestBody": { "description": "An assignment group of a specific course or a category can be selected for an alert.", "properties": { "assignmentGroupType": { "description": "Assignment group type. Valid values: `CATEGORY`, `COURSE`", "enum": [ "CATEGORY", "COURSE" ], "example": "CATEGORY", "type": "string" }, "assignmentGroupUuid": { "description": "The unique ID of the assignment group.", "format": "uuid", "type": "string" } }, "required": [ "assignmentGroupType", "assignmentGroupUuid" ], "type": "object" }, "TrainingAssignmentNearDueDateTriggerAssignmentGroupObjectResponseBody": { "description": "An assignment group of a specific course or a category can be selected for an alert.", "properties": { "assignmentGroupType": { "description": "Assignment group type. Valid values: `CATEGORY`, `COURSE`", "enum": [ "CATEGORY", "COURSE" ], "example": "CATEGORY", "type": "string" }, "assignmentGroupUuid": { "description": "The unique ID of the assignment group.", "format": "uuid", "type": "string" } }, "required": [ "assignmentGroupType", "assignmentGroupUuid" ], "type": "object" }, "TrainingAssignmentNearDueDateTriggerDetailsObjectRequestBody": { "description": "Details specific to Training Assignment Near Due Date", "properties": { "assignmentGroups": { "description": "The assignment groups the trigger is configured for.", "items": { "$ref": "#/components/schemas/TrainingAssignmentNearDueDateTriggerAssignmentGroupObjectRequestBody" }, "type": "array" }, "conditionUnits": { "description": "Whether the trigger is configured in days or weeks. Valid values: `DAYS`, `WEEKS`", "enum": [ "DAYS", "WEEKS" ], "example": "DAYS", "type": "string" }, "conditionValue": { "description": "The number of days or weeks near the due date to trigger on.", "example": 1, "format": "int64", "type": "integer" }, "timezone": { "description": "The timezone that the alert will be set up in.", "example": "America/Los_Angeles", "type": "string" } }, "required": [ "conditionUnits", "conditionValue", "timezone" ], "type": "object" }, "TrainingAssignmentNearDueDateTriggerDetailsObjectResponseBody": { "description": "Details specific to Training Assignment Near Due Date", "properties": { "assignmentGroups": { "description": "The assignment groups the trigger is configured for.", "items": { "$ref": "#/components/schemas/TrainingAssignmentNearDueDateTriggerAssignmentGroupObjectResponseBody" }, "type": "array" }, "conditionUnits": { "description": "Whether the trigger is configured in days or weeks. Valid values: `DAYS`, `WEEKS`", "enum": [ "DAYS", "WEEKS" ], "example": "DAYS", "type": "string" }, "conditionValue": { "description": "The number of days or weeks near the due date to trigger on.", "example": 1, "format": "int64", "type": "integer" }, "timezone": { "description": "The timezone that the alert will be set up in.", "example": "America/Los_Angeles", "type": "string" } }, "required": [ "conditionUnits", "conditionValue", "timezone" ], "type": "object" }, "TrainingAssignmentPostResponseObjectResponseBody": { "description": "Training Assignment response object.", "properties": { "course": { "$ref": "#/components/schemas/TrainingCourseObjectResponseBody" }, "createdAtTime": { "description": "Creation time of the training assignment. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "createdById": { "description": "ID of the user who created the training assignment.", "example": "user-4392", "type": "string" }, "dueAtTime": { "description": "Time training assignment is due. UTC timestamp in RFC 3339 format. Returned when an assignment has a due date set by an admin.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "id": { "description": "ID of the training assignment.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "isExistingAssignment": { "description": "Indicates whether the training assignment was already created.", "example": true, "type": "boolean" }, "learner": { "$ref": "#/components/schemas/TrainingLearnerObjectResponseBody" } }, "required": [ "course", "createdAtTime", "createdById", "id", "isExistingAssignment", "learner" ], "type": "object" }, "TrainingAssignmentResponseObjectResponseBody": { "description": "Training Assignment response object.", "properties": { "completedAtTime": { "description": "Time training assignment is completed. UTC timestamp in RFC 3339 format. Returned when a training assignment completion status is \"complete\".", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "course": { "$ref": "#/components/schemas/TrainingCourseObjectResponseBody" }, "createdAtTime": { "description": "Creation time of the training assignment. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "createdById": { "description": "ID of the user who created the training assignment.", "example": "user-4392", "type": "string" }, "deletedAtTime": { "description": "Time training assignment is deleted. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "dueAtTime": { "description": "Time training assignment is due. UTC timestamp in RFC 3339 format. Returned when an assignment has a due date set by an admin.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "durationMinutes": { "description": "Time spent on the training assignment.", "example": 6.11306939304932e+18, "format": "int64", "type": "integer" }, "id": { "description": "ID of the training assignment.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "isCompletedLate": { "description": "Indicates whether the training assignment was completed on time or not. Returned when a training assignment completion status is \"complete\" and has a dueAtTime set by an admin.", "example": true, "type": "boolean" }, "isOverdue": { "description": "Indicates whether the training assignment is past the due date. Returned when a training assignment completion status is 'inProgress' or 'notStarted' and has a dueAtTime set by an admin.", "example": true, "type": "boolean" }, "learner": { "$ref": "#/components/schemas/TrainingLearnerObjectResponseBody" }, "scorePercent": { "description": "Quiz score associated with training assignment. Returned when a training assignment completion status is \"complete\".", "example": 0.383064950248876, "format": "double", "type": "number" }, "startedAtTime": { "description": "Time training assignment is started. UTC timestamp in RFC 3339 format. Returned when a training assignment completion status is \"complete\" or \"inProgress\".", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "status": { "description": "State for the Training Assignment. Always returned. Valid values: `notStarted`, `inProgress`, `completed`", "enum": [ "notStarted", "inProgress", "completed" ], "example": "inProgress", "type": "string" }, "updatedAtTime": { "description": "Time training assignment was updated by either a learner or an admin. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "updatedById": { "description": "ID of the user who updated the training assignment, either an admin or a learner.", "example": "user-3112", "type": "string" } }, "required": [ "course", "createdAtTime", "createdById", "durationMinutes", "id", "learner", "status", "updatedAtTime", "updatedById" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsDeleteTrainingAssignmentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamResponseBody": { "properties": { "data": { "description": "List of training assignments.", "items": { "$ref": "#/components/schemas/TrainingAssignmentResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsGetTrainingAssignmentsStreamUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsResponseBody": { "properties": { "data": { "description": "List of updated training assignments.", "items": { "$ref": "#/components/schemas/TrainingAssignmentResponseObjectResponseBody" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPatchTrainingAssignmentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsResponseBody": { "properties": { "data": { "description": "List of created training assignments.", "items": { "$ref": "#/components/schemas/TrainingAssignmentPostResponseObjectResponseBody" }, "type": "array" } }, "required": [ "data" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingAssignmentsPostTrainingAssignmentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCategoryObjectResponseBody": { "description": "Category of the training course.", "properties": { "id": { "description": "Category ID of the course.", "example": "a4db8702-79d5-4396-a717-e301d52ecc11", "type": "string" }, "name": { "description": "Category name of the course.", "example": "Samsara Driver App", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "TrainingCourseLabelObjectResponseBody": { "description": "Label of the training course.", "properties": { "name": { "description": "Name of the course label. Valid values: “safety”.", "example": "safety", "type": "string" }, "type": { "description": "Type of the course label. Valid values when course.label.name is ‘safety’: accel, braking, crashSharpTurn, rolloverProtection, yawControl, speeding, rolledStopSign, tileRollingRailroad, seatbeltPolicy, nearCollision, phonePolicy, drowsy, defensiveDriving, driverObstructionPolicy, didNotYield, distractedDriving, tailgating, laneDeparture, lateResponse, ranRedLight, forwardCollisionWarning, foodDrinkPolicy, smokingPolicy, maskPolicy, maxSpeed, severeSpeeding, drinkPolicy, foodPolicy, unknown.", "example": "accel", "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "TrainingCourseObjectResponseBody": { "description": "Course that is associated with the training assignments.", "properties": { "id": { "description": "ID of the course.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" }, "revisionId": { "description": "ID of the course's specific version.", "example": "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7", "format": "uuid", "type": "string" } }, "required": [ "id", "revisionId" ], "type": "object" }, "TrainingCourseResponseObjectResponseBody": { "description": "Training Course response object.", "properties": { "category": { "$ref": "#/components/schemas/TrainingCategoryObjectResponseBody" }, "description": { "description": "Description of the course.", "example": "Training for how to operate a wheel loader.", "type": "string" }, "estimatedTimeToCompleteMinutes": { "description": "Estimated time it takes to complete the course.", "example": 30, "format": "int64", "type": "integer" }, "id": { "description": "ID of the training course.", "example": "a4db8702-79d5-4396-a717-e301d52ecc11", "type": "string" }, "labels": { "description": "List of course labels.", "items": { "$ref": "#/components/schemas/TrainingCourseLabelObjectResponseBody" }, "type": "array" }, "revisionId": { "description": "ID of the course's specific version.", "example": "1214a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "status": { "description": "Status of the training course. Always returned.\nNote: Only courses in a ‘published’ state are assignable to learners. Archiving a course deletes only ‘inProgress’ assignments associated with that course, and deleting a course deletes all assignments associated with that course. Valid values: `published`, `deleted`, `archived`, `unknown`", "enum": [ "published", "deleted", "archived", "unknown" ], "example": "published", "type": "string" }, "title": { "description": "Title of the course.", "example": "Wheel Loader", "type": "string" } }, "required": [ "category", "estimatedTimeToCompleteMinutes", "id", "revisionId", "status", "title" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesResponseBody": { "properties": { "data": { "description": "List of training courses.", "items": { "$ref": "#/components/schemas/TrainingCourseResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingCoursesGetTrainingCoursesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TrainingLearnerObjectResponseBody": { "description": "Learner that is associated with the training assignment. Only driver learners are supported currently.", "properties": { "id": { "description": "ID of the polymorphic user.", "example": "938172", "type": "string" }, "type": { "description": "The type of the polymorphic user. Valid values: `driver`", "enum": [ "driver" ], "example": "driver", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "TriggerParamsObjectRequestBody": { "description": "The trigger type specific details. Only the field that corresponds to the trigger type is filled in.", "properties": { "ambientTemperature": { "$ref": "#/components/schemas/AmbientTemperatureDetailsObjectRequestBody" }, "cellSignalLoss": { "$ref": "#/components/schemas/CellSignalLossDetailsObjectRequestBody" }, "defLevel": { "$ref": "#/components/schemas/DefLevelTriggerDetailsObjectRequestBody" }, "deviceMovement": { "$ref": "#/components/schemas/DeviceMovementTriggerDetailsObjectRequestBody" }, "documentSubmitted": { "$ref": "#/components/schemas/DriverDocumentSubmittedDetailsObjectRequestBody" }, "dvirSubmittedDevice": { "$ref": "#/components/schemas/DVIRSubmittedDeviceTriggerDetailsObjectRequestBody" }, "engineIdle": { "$ref": "#/components/schemas/EngineIdleTriggerDetailsObjectRequestBody" }, "engineOff": { "$ref": "#/components/schemas/EngineOffDetailsObjectRequestBody" }, "engineOn": { "$ref": "#/components/schemas/EngineOnDetailsObjectRequestBody" }, "fuelLevel": { "$ref": "#/components/schemas/FuelLevelTriggerDetailsObjectRequestBody" }, "gatewayDisconnected": { "$ref": "#/components/schemas/GatewayDisconnectedDetailsObjectRequestBody" }, "gatewayUnplugged": { "$ref": "#/components/schemas/GatewayUnpluggedTriggerDetailsObjectRequestBody" }, "geofenceEntry": { "$ref": "#/components/schemas/GeofenceEntryTriggerDetailsObjectRequestBody" }, "geofenceExit": { "$ref": "#/components/schemas/GeofenceExitTriggerDetailsObjectRequestBody" }, "gpsSignalLoss": { "$ref": "#/components/schemas/GpsSignalLossDetailsObjectRequestBody" }, "harshEvent": { "$ref": "#/components/schemas/HarshEventTriggerDetailsObjectRequestBody" }, "hosViolation": { "$ref": "#/components/schemas/HOSViolationTriggerDetailsObjectRequestBody" }, "insideGeofence": { "$ref": "#/components/schemas/InsideGeofenceTriggerDetailsObjectRequestBody" }, "outOfRoute": { "$ref": "#/components/schemas/OutOfRouteDetailsObjectRequestBody" }, "outsideGeofence": { "$ref": "#/components/schemas/OutsideGeofenceTriggerDetailsObjectRequestBody" }, "panicButton": { "$ref": "#/components/schemas/PanicButtonDetailsObjectRequestBody" }, "routeStopEstimatedArrival": { "$ref": "#/components/schemas/RouteStopEstimatedArrivalDetailsObjectRequestBody" }, "scheduledMaintenance": { "$ref": "#/components/schemas/ScheduledMaintenanceTriggerDetailsObjectRequestBody" }, "scheduledMaintenanceByEngineHours": { "$ref": "#/components/schemas/ScheduledMaintenanceByEngineHoursDetailsObjectRequestBody" }, "scheduledMaintenanceOdometer": { "$ref": "#/components/schemas/ScheduledMaintenanceOdometerTriggerDetailsObjectRequestBody" }, "speed": { "$ref": "#/components/schemas/SpeedTriggerDetailsObjectRequestBody" }, "suddenFuelLevelDrop": { "$ref": "#/components/schemas/SuddenFuelLevelDropTriggerDetailsObjectRequestBody" }, "suddenFuelLevelRise": { "$ref": "#/components/schemas/SuddenFuelLevelRiseTriggerDetailsObjectRequestBody" }, "tireFaultCode": { "$ref": "#/components/schemas/TireFaultCodeDetailsObjectRequestBody" }, "trainingAssignmentNearDueDate": { "$ref": "#/components/schemas/TrainingAssignmentNearDueDateTriggerDetailsObjectRequestBody" }, "unassignedDriving": { "$ref": "#/components/schemas/UnassignedDrivingTriggerDetailsObjectRequestBody" }, "vehicleBatteryVoltage": { "$ref": "#/components/schemas/VehicleBatterVoltageDetailsObjectRequestBody" }, "vehicleFaultCode": { "$ref": "#/components/schemas/VehicleFaultCodeDetailsObjectRequestBody" } }, "type": "object" }, "TriggerParamsObjectResponseBody": { "description": "The trigger type specific details. Only the field that corresponds to the trigger type is filled in.", "properties": { "ambientTemperature": { "$ref": "#/components/schemas/AmbientTemperatureDetailsObjectResponseBody" }, "cellSignalLoss": { "$ref": "#/components/schemas/CellSignalLossDetailsObjectResponseBody" }, "defLevel": { "$ref": "#/components/schemas/DefLevelTriggerDetailsObjectResponseBody" }, "deviceMovement": { "$ref": "#/components/schemas/DeviceMovementTriggerDetailsObjectResponseBody" }, "documentSubmitted": { "$ref": "#/components/schemas/DriverDocumentSubmittedDetailsObjectResponseBody" }, "dvirSubmittedDevice": { "$ref": "#/components/schemas/DVIRSubmittedDeviceTriggerDetailsObjectResponseBody" }, "engineIdle": { "$ref": "#/components/schemas/EngineIdleTriggerDetailsObjectResponseBody" }, "engineOff": { "$ref": "#/components/schemas/EngineOffDetailsObjectResponseBody" }, "engineOn": { "$ref": "#/components/schemas/EngineOnDetailsObjectResponseBody" }, "fuelLevel": { "$ref": "#/components/schemas/FuelLevelTriggerDetailsObjectResponseBody" }, "gatewayDisconnected": { "$ref": "#/components/schemas/GatewayDisconnectedDetailsObjectResponseBody" }, "gatewayUnplugged": { "$ref": "#/components/schemas/GatewayUnpluggedTriggerDetailsObjectResponseBody" }, "geofenceEntry": { "$ref": "#/components/schemas/GeofenceEntryTriggerDetailsObjectResponseBody" }, "geofenceExit": { "$ref": "#/components/schemas/GeofenceExitTriggerDetailsObjectResponseBody" }, "gpsSignalLoss": { "$ref": "#/components/schemas/GpsSignalLossDetailsObjectResponseBody" }, "harshEvent": { "$ref": "#/components/schemas/HarshEventTriggerDetailsObjectResponseBody" }, "hosViolation": { "$ref": "#/components/schemas/HOSViolationTriggerDetailsObjectResponseBody" }, "insideGeofence": { "$ref": "#/components/schemas/InsideGeofenceTriggerDetailsObjectResponseBody" }, "outOfRoute": { "$ref": "#/components/schemas/OutOfRouteDetailsObjectResponseBody" }, "outsideGeofence": { "$ref": "#/components/schemas/OutsideGeofenceTriggerDetailsObjectResponseBody" }, "panicButton": { "$ref": "#/components/schemas/PanicButtonDetailsObjectResponseBody" }, "routeStopEstimatedArrival": { "$ref": "#/components/schemas/RouteStopEstimatedArrivalDetailsObjectResponseBody" }, "scheduledMaintenance": { "$ref": "#/components/schemas/ScheduledMaintenanceTriggerDetailsObjectResponseBody" }, "scheduledMaintenanceByEngineHours": { "$ref": "#/components/schemas/ScheduledMaintenanceByEngineHoursDetailsObjectResponseBody" }, "scheduledMaintenanceOdometer": { "$ref": "#/components/schemas/ScheduledMaintenanceOdometerTriggerDetailsObjectResponseBody" }, "speed": { "$ref": "#/components/schemas/SpeedTriggerDetailsObjectResponseBody" }, "suddenFuelLevelDrop": { "$ref": "#/components/schemas/SuddenFuelLevelDropTriggerDetailsObjectResponseBody" }, "suddenFuelLevelRise": { "$ref": "#/components/schemas/SuddenFuelLevelRiseTriggerDetailsObjectResponseBody" }, "tireFaultCode": { "$ref": "#/components/schemas/TireFaultCodeDetailsObjectResponseBody" }, "trainingAssignmentNearDueDate": { "$ref": "#/components/schemas/TrainingAssignmentNearDueDateTriggerDetailsObjectResponseBody" }, "unassignedDriving": { "$ref": "#/components/schemas/UnassignedDrivingTriggerDetailsObjectResponseBody" }, "vehicleBatteryVoltage": { "$ref": "#/components/schemas/VehicleBatterVoltageDetailsObjectResponseBody" }, "vehicleFaultCode": { "$ref": "#/components/schemas/VehicleFaultCodeDetailsObjectResponseBody" } }, "type": "object" }, "TripAssetResponseBody": { "description": "Asset that the location readings are tied to", "properties": { "id": { "description": "Unique ID for the asset object that is reporting the location.", "example": "12345", "type": "string" }, "name": { "description": "Name for the asset object that is reporting the location. Only returns when `includeAsset` is set to `true`.", "example": "MyAsset-1234", "type": "string" }, "type": { "description": "Type for the asset object that is reporting the location. Only returns when `includeAsset` is set to `true`. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "trailer", "type": "string" }, "vin": { "description": "VIN for the asset object that is reporting the location. Only returns when `includeAsset` is set to `true`.", "example": "1GBJ6P1B2HV112765", "type": "string" } }, "required": [ "id" ], "type": "object" }, "TripResponseBody": { "description": "Trip", "properties": { "asset": { "$ref": "#/components/schemas/TripAssetResponseBody" }, "completionStatus": { "description": "Trip completion status Valid values: `inProgress`, `completed`", "enum": [ "inProgress", "completed" ], "example": "completed", "type": "string" }, "createdAtTime": { "description": "[RFC 3339] Time the trip was created in Samsara in UTC.", "example": "2024-04-16T19:08:25Z", "type": "string" }, "endLocation": { "$ref": "#/components/schemas/LocationResponseResponseBody" }, "startLocation": { "$ref": "#/components/schemas/LocationResponseResponseBody" }, "tripEndTime": { "description": "[RFC 3339] Time the trip ended in UTC.", "example": "2024-04-16T20:00:00Z", "type": "string" }, "tripStartTime": { "description": "[RFC 3339] Time the trip started in UTC.", "example": "2024-04-16T19:08:25Z", "type": "string" }, "updatedAtTime": { "description": "[RFC 3339] Time the trip was updated in Samsara in UTC. Valid updates are when `endTime` populates or `completionStatus` changes values.", "example": "2024-04-16T19:08:25Z", "type": "string" } }, "required": [ "asset", "completionStatus", "createdAtTime", "startLocation", "tripStartTime", "updatedAtTime" ], "type": "object" }, "TripSpeedingIntervalsResponseBody": { "description": "TripSpeedingIntervals", "properties": { "asset": { "$ref": "#/components/schemas/TripAssetResponseBody" }, "createdAtTime": { "description": "UTC time the trip was created in Samsara in RFC 3339 format.", "example": "2023-01-27T07:06:25Z", "type": "string" }, "driverId": { "description": "The driver ID assigned to the trip. Only returned if includeDriverId is set to true. 'null' if no driver id.", "example": "12345", "type": "string" }, "intervals": { "description": "List of speeding intervals that belong to the trip. The full list of intervals associated with the trip is always returned, empty if no intervals exist.", "items": { "$ref": "#/components/schemas/SpeedingIntervalResponseBody" }, "type": "array" }, "tripStartTime": { "description": "UTC time the trip started in RFC 3339 format.", "example": "2023-01-27T07:06:25Z", "type": "string" }, "updatedAtTime": { "description": "UTC time the trip was last updated in Samsara in RFC 3339 format. Valid updates are when trip's endTime populates or interval.isDismissed changes value.", "example": "2023-01-27T10:04:20Z", "type": "string" } }, "required": [ "asset", "createdAtTime", "intervals", "tripStartTime", "updatedAtTime" ], "type": "object" }, "TripsGetTripsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TripsGetTripsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TripsGetTripsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TripsGetTripsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TripsGetTripsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TripsGetTripsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TripsGetTripsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TripsGetTripsResponseBody": { "properties": { "data": { "description": "List of trips", "items": { "$ref": "#/components/schemas/TripResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "TripsGetTripsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TripsGetTripsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "TripsGetTripsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "UnassignedDrivingDataResponseBody": { "description": "Details specific to Unassigned Driving.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "UnassignedDrivingTriggerDetailsObjectRequestBody": { "description": "Details specific to Unassigned Driving", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "UnassignedDrivingTriggerDetailsObjectResponseBody": { "description": "Details specific to Unassigned Driving", "properties": { "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" } }, "required": [ "minDurationMilliseconds" ], "type": "object" }, "UpdateAddressRequest": { "description": "A request body to update an Address.", "properties": { "addressTypes": { "description": "Reporting location type associated with the address (used for ELD reporting purposes). Valid values: `yard`, `shortHaul`, `workforceSite`, `riskZone`, `industrialSite`, `alertsOnly`, `agricultureSource`.", "items": { "enum": [ "yard", "shortHaul", "workforceSite", "riskZone", "industrialSite", "alertsOnly", "agricultureSource" ], "example": "yard", "type": "string" }, "type": "array" }, "contactIds": { "description": "An array of Contact IDs associated with this Address.", "items": { "example": "22408", "type": "string" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "formattedAddress": { "description": "The full street address for this address/geofence, as it might be recognized by Google Maps.", "example": "350 Rhode Island St, San Francisco, CA", "maxLength": 1024, "type": "string" }, "geofence": { "$ref": "#/components/schemas/UpdateAddressRequest_geofence" }, "latitude": { "description": "Latitude of the address. Will be geocoded from `formattedAddress` if not provided.", "example": 37.765363, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the address. Will be geocoded from `formattedAddress` if not provided.", "example": -122.4029238, "format": "double", "type": "number" }, "name": { "description": "Name of the address.", "example": "Samsara HQ", "maxLength": 255, "type": "string" }, "notes": { "description": "Notes about the address.", "example": "Hours of operation: 8am - 6pm; Truck entrance on the Rhode Island street side.", "maxLength": 280, "type": "string" }, "tagIds": { "description": "An array of IDs of tags to associate with this address.", "items": { "example": "3914", "type": "string" }, "type": "array" } }, "type": "object" }, "UpdateAddressRequest_geofence": { "description": "The geofence that defines this address and its bounds. This can either be a circle or a polygon, but not both.", "properties": { "circle": { "$ref": "#/components/schemas/AddressGeofence_circle" }, "polygon": { "$ref": "#/components/schemas/AddressGeofence_polygon" }, "settings": { "$ref": "#/components/schemas/AddressGeofence_settings" } }, "type": "object" }, "UpdateAttributeRequest": { "description": "A request body to update an Attribute.", "properties": { "attributeType": { "default": "string", "description": "Denotes the data type of the attribute's values. Valid values: `string`, `number`.", "enum": [ "string", "number" ], "example": "string", "type": "string" }, "attributeValueQuantity": { "default": "multi", "description": "Defines whether or not this attribute can be used on the same entity many times (with different values). Denotes the type of entity, driver or asset. Valid values: `driver`, `asset`.", "enum": [ "single", "multi" ], "example": "multi", "type": "string" }, "entities": { "description": "Entities that will be applied to this attribute", "items": { "$ref": "#/components/schemas/CreateAttributeRequest_entities" }, "type": "array" }, "entityType": { "description": "Denotes the type of entity, driver or asset.", "enum": [ "driver", "asset" ], "example": "asset", "type": "string" }, "name": { "description": "Name", "example": "License Certifications", "type": "string" }, "numberValues": { "description": "Number values that can be associated with this attribute", "items": { "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "String values that can be associated with this attribute", "items": { "type": "string" }, "type": "array" } }, "required": [ "entityType" ], "type": "object" }, "UpdateContactRequest": { "description": "Information for adding a notification contact for alerts.", "properties": { "email": { "description": "Email address of the contact.", "example": "jane.jones@yahoo.com", "maxLength": 255, "type": "string" }, "firstName": { "description": "First name of the contact.", "example": "Jane", "maxLength": 255, "type": "string" }, "lastName": { "description": "Last name of the contact.", "example": "Jones", "maxLength": 255, "type": "string" }, "phone": { "description": "Phone number of the contact.", "example": "111-222-3344", "maxLength": 255, "type": "string" } }, "type": "object" }, "UpdateDriverRequest": { "description": "Driver that should be updated.", "properties": { "attributes": { "items": { "$ref": "#/components/schemas/CreateDriverRequest_attributes" }, "type": "array" }, "carrierSettings": { "$ref": "#/components/schemas/DriverCarrierSettings" }, "currentIdCardCode": { "description": "The ID Card Code on the back of the physical card assigned to the driver. Contact Samsara if you would like to enable this feature.", "example": "941767043", "type": "string" }, "deactivatedAtTime": { "description": "The date and time this driver is considered to be deactivated in RFC 3339 format.", "example": "2019-05-18T20:27:35Z", "type": "string" }, "driverActivationStatus": { "description": "A value indicating whether the driver is active or deactivated. Valid values: `active`, `deactivated`.", "enum": [ "active", "deactivated" ], "type": "string" }, "eldAdverseWeatherExemptionEnabled": { "description": "Flag indicating this driver may use Adverse Weather exemptions in ELD logs.", "type": "boolean" }, "eldBigDayExemptionEnabled": { "description": "Flag indicating this driver may use Big Day exemption in ELD logs.", "type": "boolean" }, "eldDayStartHour": { "description": "`0` indicating midnight-to-midnight ELD driving hours, `12` to indicate noon-to-noon driving hours.", "type": "integer" }, "eldExempt": { "description": "Flag indicating this driver is exempt from the Electronic Logging Mandate.", "type": "boolean" }, "eldExemptReason": { "description": "Reason that this driver is exempt from the Electronic Logging Mandate (see eldExempt).", "example": "Bad driver", "type": "string" }, "eldPcEnabled": { "description": "Flag indicating this driver may select the Personal Conveyance duty status in ELD logs.", "type": "boolean" }, "eldYmEnabled": { "description": "Flag indicating this driver may select the Yard Move duty status in ELD logs.", "type": "boolean" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "hasDrivingFeaturesHidden": { "$ref": "#/components/schemas/DriverHasDrivingFeaturesHidden" }, "hosSetting": { "$ref": "#/components/schemas/UpdateDriverRequest_hosSetting" }, "licenseNumber": { "description": "Driver's state issued license number. The combination of this number and `licenseState` must be unique.", "example": "E1234567", "type": "string" }, "licenseState": { "description": "Abbreviation of US state, Canadian province, or US territory that issued driver's license.", "example": "CA", "type": "string" }, "locale": { "description": "Locale override (uncommon). These are specified by ISO 3166-2 country codes for supported locales. Valid values: `us`, `at`, `be`, `ca`, `gb`, `fr`, `de`, `ie`, `it`, `lu`, `mx`, `nl`, `es`, `ch`, `pr`.", "enum": [ "us", "at", "be", "ca", "gb", "fr", "de", "ie", "it", "lu", "mx", "nl", "es", "ch", "pr" ], "type": "string" }, "name": { "description": "Driver's name.", "example": "Susan Jones", "maxLength": 255, "minLength": 1, "type": "string" }, "notes": { "description": "Notes about the driver.", "example": "Also goes by the nickname Furious Fred.", "maxLength": 4096, "type": "string" }, "password": { "description": "Password that the driver can use to login to the Samsara driver app.", "example": "aSecurePassword1234", "type": "string" }, "peerGroupTagId": { "description": "The peer group tag id this driver belong to, leave blank to be in group with everyone, used for gamification.", "type": "string" }, "phone": { "description": "Phone number of the driver.", "example": "5558234327", "maxLength": 255, "type": "string" }, "staticAssignedVehicleId": { "description": "ID of vehicle that the driver is permanently assigned to. (uncommon).", "example": "456", "type": "string" }, "tachographCardNumber": { "description": "Driver's assigned tachograph card number (Europe specific)", "example": "1000000492436002", "type": "string" }, "tagIds": { "description": "IDs of tags the driver is associated with. If your access to the API is scoped by one or more tags, this field is required to pass in.", "items": { "example": "147", "type": "string" }, "type": "array" }, "timezone": { "description": "Home terminal timezone, in order to indicate what time zone should be used to calculate the ELD logs. Driver timezones use [IANA timezone database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`, `America/New_York`, `Europe/London`, etc.). You can find a mapping of common timezone formats to IANA timezone keys [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).", "example": "America/Los_Angeles", "type": "string" }, "usDriverRulesetOverride": { "$ref": "#/components/schemas/UsDriverRulesetOverride" }, "username": { "description": "Driver's login username into the driver app. The username may not contain spaces or the '@' symbol. The username must be unique.", "example": "SusanJones", "maxLength": 189, "minLength": 1, "type": "string" }, "vehicleGroupTagId": { "description": "Tag ID which determines which vehicles a driver will see when selecting vehicles.", "example": "342417", "type": "string" }, "waitingTimeDutyStatusEnabled": { "description": "Flag indicating this driver may select waiting time duty status in ELD logs", "type": "boolean" } }, "type": "object" }, "UpdateDriverRequest_hosSetting": { "description": "Hos settings for a driver.", "properties": { "heavyHaulExemptionToggleEnabled": { "$ref": "#/components/schemas/DriverHeavyHaulExemptionToggleEnabled" } }, "type": "object" }, "UpdateDvirRequest": { "description": "Information about resolving a DVIR.", "properties": { "authorId": { "description": "The user who is resolving the dvir.", "example": "11", "type": "string" }, "isResolved": { "description": "Resolves the DVIR. Must be `true`.", "type": "boolean" }, "mechanicNotes": { "description": "The mechanics notes on the DVIR.", "example": "Replaced headlight on passenger side.", "type": "string" }, "signedAtTime": { "description": "Time when user signed this DVIR. Defaults to now. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" } }, "required": [ "authorId", "isResolved" ], "type": "object" }, "UpdateEngineImmobilizerRelayStateRequestBodyRequestBody": { "description": "A request object to update a relay state.", "properties": { "id": { "description": "The ID of the relay Valid values: `relay1`, `relay2`", "enum": [ "relay1", "relay2" ], "example": "relay1", "type": "string" }, "isOpen": { "description": "The desired state of the relay. Provide `true` to open the relay, or `false` to close the relay.", "example": false, "type": "boolean" } }, "required": [ "id", "isOpen" ], "type": "object" }, "UpdateRoutesStopRequestObjectRequestBody": { "properties": { "addressId": { "description": "ID of the address. An address [externalId](https://developers.samsara.com/docs/external-ids#using-external-ids) can also be used interchangeably here.", "example": "45934", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the stop", "example": "4125", "type": "string" }, "name": { "description": "Name of the stop", "example": "Stop #1", "type": "string" }, "notes": { "description": "Notes for the stop", "example": "These are my notes", "maxLength": 2000, "type": "string" }, "ontimeWindowAfterArrivalMs": { "description": "Specifies the time window (in milliseconds) after a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "maximum": 259200000, "minimum": 0, "type": "integer" }, "ontimeWindowBeforeArrivalMs": { "description": "Specifies the time window (in milliseconds) before a stop's scheduled arrival time during which the stop is considered 'on-time'.", "example": 300000, "maximum": 259200000, "minimum": 0, "type": "integer" }, "scheduledArrivalTime": { "description": "This is a required field for all stops EXCEPT the start and end, based on route start and stop settings selected.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "scheduledDepartureTime": { "description": "This is a required field for all stops EXCEPT the start and end, based on route start and stop settings selected.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "singleUseLocation": { "$ref": "#/components/schemas/RoutesSingleUseAddressObjectRequestBody" } }, "type": "object" }, "UpdateUserRequest": { "description": "The user update arguments", "properties": { "authType": { "description": "The authentication type the user uses to authenticate. To use SAML this organization must have a configured SAML integration. Valid values: `default`, `saml`.", "enum": [ "default", "saml" ], "type": "string" }, "expireAt": { "description": "For users with temporary access, this is the expiration datetime in RFC3339 format", "example": "2025-08-13T19:08:25Z", "type": "string" }, "name": { "description": "The first and last name of the user.", "example": "Bob Smith", "type": "string" }, "roles": { "description": "The list of roles that applies to this user. A user may have \"organizational\" roles, which apply to the user at the organizational level, and \"tag-specific\" roles, which apply to the user for a given tag.", "items": { "$ref": "#/components/schemas/CreateUserRequest_roles" }, "type": "array" } }, "type": "object" }, "UpdateVehicleRequest": { "description": "All the editable portions of the vehicle object.", "properties": { "attributes": { "items": { "$ref": "#/components/schemas/attributeTiny" }, "type": "array" }, "auxInputType1": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType10": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType11": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType12": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType13": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType2": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType3": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType4": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType5": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType6": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType7": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType8": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "auxInputType9": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. Valid values: `None`, `Emergency Lights`, `Emergency Alarm`, `Stop Paddle`, `Power Take-Off`, `Plow`, `Sweeper`, `Salter`, `Reefer`, `Door`, `Boom`, `Auxiliary Engine`, `Generator`, `Eight-Way Lights`, `Panic Button`, `Privacy Button`, `Front Axle Drive`, `Weight Sensor`, `Other`, `Secondary Fuel Source`, `(ECU) Power Take-Off`.", "enum": [ "none", "emergencyLights", "emergencyAlarm", "stopPaddle", "powerTakeOff", "plow", "sweeper", "salter", "reefer", "door", "boom", "auxiliaryEngine", "generator", "eightWayLights", "panicButton", "privacyButton", "frontAxleDrive", "weightSensor", "other", "secondaryFuelSource", "ecuPowerTakeOff" ], "example": "boom", "type": "string" }, "engineHours": { "description": "A manual override for the vehicle's engine hours. You may only override a vehicle's engine hours if it cannot be read from on-board diagnostics. When you provide a manual engine hours override, Samsara will begin updating a vehicle's engine hours based on when the Samsara Vehicle Gateway is recieving power or not. Setting the value to 0 will unset the manual engine hours.", "example": 10943, "format": "int64", "type": "integer" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "The \u003Ca href=\"/docs/external-ids\" target=\"_blank\"\u003Eexternal IDs\u003C/a\u003E for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "gatewaySerial": { "$ref": "#/components/schemas/UserIdentifierSerial" }, "grossVehicleWeight": { "$ref": "#/components/schemas/GrossVehicleWeight" }, "harshAccelerationSettingType": { "description": "The harsh acceleration setting type. This setting influences the acceleration sensitivity from which a \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043051792-Safety-Event-Overview\" target=\"_blank\"\u003Eharsh event\u003C/a\u003E is triggered. **By default**, this setting is inferred by the Samsara Vehicle Gateway from the engine computer, but it may be set or updated through the Samsara Dashboard or the API at any time. If set to `off`, then no acceleration based harsh events are triggered for the vehicle. Valid values: `passengerCar`, `lightTruck`, `heavyDuty`, `off`, `automatic`.", "enum": [ "passengerCar", "lightTruck", "heavyDuty", "off", "automatic" ], "example": "off", "type": "string" }, "licensePlate": { "description": "The license plate of the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "XHK1234", "maxLength": 12, "type": "string" }, "name": { "description": "The human-readable name of the Vehicle. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. **By default**, this name is the serial number of the Samsara Vehicle Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Truck A7", "type": "string" }, "notes": { "description": "These are generic notes about the Vehicle. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are notes about this given vehicle.", "maxLength": 255, "type": "string" }, "odometerMeters": { "description": "A manual override for the vehicle's odometer. You may only override a vehicle's odometer if it cannot be read from on-board diagnostics. When you provide a manual odometer override, Samsara will begin updating a vehicle's odometer using GPS distance traveled since this override was set. See \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/115005273667\" target=\"_blank\"\u003Ehere\u003C/a\u003E for more details.", "example": 9182, "format": "int64", "type": "integer" }, "staticAssignedDriverId": { "description": "ID for the static assigned driver of the vehicle. Setting the value to 0 will unassign the current driver.", "example": "123", "type": "string" }, "tagIds": { "description": "An array of IDs of tags to associate with this vehicle. If your access to the API is scoped by one or more tags, this field is required to pass in.", "items": { "example": "321", "type": "string" }, "type": "array" }, "vehicleRegulationMode": { "$ref": "#/components/schemas/VehicleRegulationMode" }, "vehicleType": { "$ref": "#/components/schemas/VehicleType" }, "vin": { "description": "The VIN of the Vehicle. Most of the time, this will be automatically read from the engine computer by the Samsara Vehicle Gateway. It will be empty if it cannot be read. It can be set or updated through the Samsara Dashboard or the API at any time.", "example": "1FUJA6BD31LJ09646", "maxLength": 17, "minLength": 11, "type": "string" } }, "type": "object" }, "UploadedMediaObjectResponseBody": { "properties": { "availableAtTime": { "description": "Timestamp, in RFC 3339 format, at which the media item was made available. Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00", "example": "2019-11-11T14:00:12-04:00", "type": "string" }, "endTime": { "description": " An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "input": { "description": "Input type for this media. Examples: dashcamForwardFacing Valid values: `dashcamForwardFacing`, `dashcamInwardFacing`, `dashcamRearFacing`", "enum": [ "dashcamForwardFacing", "dashcamInwardFacing", "dashcamRearFacing" ], "example": "dashcamForwardFacing", "type": "string" }, "mediaType": { "description": "Type of media. Examples: image Valid values: `image`", "enum": [ "image" ], "example": "image", "type": "string" }, "startTime": { "description": " A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "triggerReason": { "description": "Trigger reason for this media capture. Examples: api Valid values: `api`, `panicButton`, `periodicStill`, `safetyEvent`, `tripEndStill`, `tripStartStill`, `videoRetrieval`", "enum": [ "api", "panicButton", "periodicStill", "safetyEvent", "tripEndStill", "tripStartStill", "videoRetrieval" ], "example": "api", "type": "string" }, "urlInfo": { "$ref": "#/components/schemas/UrlInfoObjectResponseBody" }, "vehicleId": { "description": "Vehicle ID for which this media was captured. Examples: 1234", "example": "1234", "type": "string" } }, "required": [ "availableAtTime", "endTime", "input", "mediaType", "startTime", "triggerReason", "vehicleId" ], "type": "object" }, "UrlInfoObjectResponseBody": { "description": "URL info for this piece of media. This field is only populated when the 'status' response field is 'available'", "properties": { "url": { "description": "Signed URL for this piece of media. The URL expires in 8 hours (after which you must make another GET request). Examples: https://sample.s3.url.com/image.jpeg", "example": "https://sample.s3.url.com/image.jpeg", "type": "string" }, "urlExpiryTime": { "description": "Timestamp, in RFC 3339 format, at which the URL expires. Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00", "example": "2019-11-11T14:00:12-04:00", "type": "string" } }, "required": [ "url", "urlExpiryTime" ], "type": "object" }, "UsDriverRulesetOverride": { "description": "US Driver Ruleset override for a given driver. If the driver is operating under a ruleset different from the organization default, the override is used. Updating this value only updates the override setting for this driver. Explicitly setting this field to `null` will delete driver's ruleset override. If the driver does not have an override ruleset set, the response will not include any usDriverRulesetOverride information.", "properties": { "cycle": { "description": "The driver's working cycle. Valid values: `USA Property (8/70)`, `USA Property (7/60)`, `USA Passenger (8/70)`, `USA Passenger (7/60)`, `Alaska Property (8/80)`, `Alaska Property (7/70)`, `Alaska Passenger (8/80)`, `Alaska Passenger (7/70)`, `California School/FLV (8/80)`, `California Farm (8/112)`, `California Property (8/80)`, `California Flammable Liquid (8/80)`, `California Passenger (8/80)`, `California Motion Picture (8/80)`, `Florida (8/80)`, `Florida (7/70)`, `Nebraska (8/80)`, `Nebraska (7/70)`, `North Carolina (8/80)`, `North Carolina (7/70)`, `Oklahoma (8/70)`, `Oklahoma (7/60)`, `Oregon (8/80)`, `Oregon (7/70)`, `South Carolina (8/80)`, `South Carolina (7/70)`, `Texas (7/70)`, `Wisconsin (8/80)`, `Wisconsin (7/70)`", "enum": [ "USA Property (8/70)", "USA Property (7/60)", "USA Passenger (8/70)", "USA Passenger (7/60)", "Alaska Property (8/80)", "Alaska Property (7/70)", "Alaska Passenger (8/80)", "Alaska Passenger (7/70)", "California School/FLV (8/80)", "California Farm (8/112)", "California Property (8/80)", "California Flammable Liquid (8/80)", "California Passenger (8/80)", "California Motion Picture (8/80)", "Florida (8/80)", "Florida (7/70)", "Nebraska (8/80)", "Nebraska (7/70)", "North Carolina (8/80)", "North Carolina (7/70)", "Oklahoma (8/70)", "Oklahoma (7/60)", "Oregon (8/80)", "Oregon (7/70)", "South Carolina (8/80)", "South Carolina (7/70)", "Texas (7/70)", "Wisconsin (8/80)", "Wisconsin (7/70)" ], "example": "TX 70 hour / 7 day", "type": "string" }, "restart": { "description": "Amount of time necessary for the driver to be resting in order to restart their cycle. Valid values: `34-hour Restart`, `24-hour Restart`, `36-hour Restart`, `72-hour Restart`, `None`.", "enum": [ "34-hour Restart", "24-hour Restart", "36-hour Restart", "72-hour Restart", "None" ], "example": "34-hour Restart", "type": "string" }, "restbreak": { "description": "The restbreak required for this driver. Valid values: `Property (off-duty/sleeper)`, `California Mealbreak (off-duty/sleeper)`, `None`.", "enum": [ "Property (off-duty/sleeper)", "California Mealbreak (off-duty/sleeper)", "None" ], "example": "None", "type": "string" }, "usStateToOverride": { "description": "The jurisdiction of the ruleset applied to this driver. These are specified by either the ISO 3166-2 postal code for the supported US states, or empty string '' for US Federal Ruleset jurisdiction. Valid values: ``, `AK`, `CA`, `FL`, `NE`, `NC`, `OK`, `OR`, `SC`, `TX`, `WI`.", "enum": [ "", "AK", "CA", "FL", "NE", "NC", "OK", "OR", "SC", "TX", "WI" ], "example": "TX", "type": "string" } }, "required": [ "cycle", "restart", "restbreak", "usStateToOverride" ], "type": "object" }, "User": { "description": "A user object.", "properties": { "authType": { "$ref": "#/components/schemas/UserAuthType" }, "email": { "$ref": "#/components/schemas/UserEmail" }, "id": { "$ref": "#/components/schemas/UserId" }, "name": { "$ref": "#/components/schemas/UserName" }, "roles": { "$ref": "#/components/schemas/UserRoles" } }, "required": [ "authType", "email", "id", "name", "roles" ], "type": "object" }, "UserAuthType": { "description": "The authentication type the user uses to authenticate. To use SAML this organization must have a configured SAML integration. Valid values: `default`, `saml`.", "enum": [ "default", "saml" ], "type": "string" }, "UserEmail": { "description": "The email address of this user.", "example": "user@company.com", "type": "string" }, "UserExpireAt": { "description": "For user account expiration, the access expiration datetime in RFC3339 format", "example": "2025-08-13T19:08:25Z", "type": "string" }, "UserId": { "description": "ID of the user.", "example": "123", "type": "string" }, "UserIdentifierSerial": { "description": "The serial number of the gateway. **By default**: empty. This can be set to a different gateway's serial number to pair this vehicle with a different gateway.", "example": "ABCD-123-XYZ", "type": "string" }, "UserName": { "description": "The first and last name of the user.", "example": "Bob Smith", "type": "string" }, "UserResponse": { "description": "A single user.", "properties": { "data": { "$ref": "#/components/schemas/User" } }, "type": "object" }, "UserRole": { "description": "A user role object.", "properties": { "id": { "description": "The unique ID for the role.", "example": "8a9371af-82d1-4158-bf91-4ecc8d3a114c", "type": "string" }, "name": { "description": "The name of the role.", "example": "Full Admin", "type": "string" } }, "type": "object" }, "UserRoleAssignment": { "description": "A role that applies to a user. If the role has a `tag`, then the role applies for that tag. If there is no `tag`, then the role applies at the organizational level. A user may have many tag-specific roles, but may only have one organizational level role. If the organizational level role has higher privileges than a tag-specific role, then the organizational role privileges will take precedence.", "properties": { "expireAt": { "$ref": "#/components/schemas/UserExpireAt" }, "role": { "$ref": "#/components/schemas/UserRole" }, "tag": { "$ref": "#/components/schemas/tagTinyResponse" } }, "type": "object" }, "UserRoleAssignmentRequest": { "description": "A role that applies to a user. If the role has a `tagId`, then the role applies for that tag. If there is no `tagId`, then the role applies at the organizational level. A user may have many tag-specific roles, but may only have one organizational role. If the organizational level role has higher privileges than a tag-specific role, then the organizational role privileges will take precedence.", "properties": { "roleId": { "description": "The unique ID for the role.", "example": "8a9371af-82d1-4158-bf91-4ecc8d3a114c", "type": "string" }, "tagId": { "description": "ID of the tag this role applies to.", "example": "3914", "type": "string" } }, "required": [ "roleId" ], "type": "object" }, "UserRoles": { "description": "The list of roles that applies to this user. A user may have \"organizational\" roles, which apply to the user at the organizational level, and \"tag-specific\" roles, which apply to the user for a given tag.", "items": { "$ref": "#/components/schemas/UserRoleAssignment" }, "type": "array" }, "UserRolesRequest": { "description": "The list of roles that applies to this user. A user may have \"organizational\" roles, which apply to the user at the organizational level, and \"tag-specific\" roles, which apply to the user for a given tag.", "items": { "$ref": "#/components/schemas/UserRoleAssignmentRequest" }, "type": "array" }, "V1Asset": { "description": "Basic information of an asset", "properties": { "assetSerialNumber": { "description": "Serial number of the host asset", "example": "SNTEST123", "type": "string" }, "cable": { "$ref": "#/components/schemas/V1Asset_cable" }, "engineHours": { "description": "Engine hours", "example": 104, "type": "integer" }, "id": { "description": "Asset ID", "example": 1, "format": "int64", "type": "integer" }, "name": { "description": "Asset name", "example": "Trailer 123", "type": "string" }, "vehicleId": { "description": "The ID of the Vehicle associated to the Asset (if present)", "example": 2, "format": "int64", "type": "integer" } }, "required": [ "id" ], "type": "object" }, "V1AssetCurrentLocation": { "description": "Current location of an asset", "properties": { "latitude": { "description": "The latitude of the location in degrees.", "example": 37, "type": "number" }, "location": { "description": "The best effort (street,city,state) for the latitude and longitude.", "example": "525 York, San Francisco, CA", "type": "string" }, "longitude": { "description": "The longitude of the location in degrees.", "example": -122.7, "type": "number" }, "speedMilesPerHour": { "description": "The speed calculated from GPS that the asset was traveling at in miles per hour.", "example": 35, "type": "number" }, "timeMs": { "description": "Time in Unix milliseconds since epoch when the asset was at the location.", "example": 12314151, "type": "number" } }, "type": "object" }, "V1AssetCurrentLocationsResponse": { "description": "Basic information of an asset", "properties": { "assetSerialNumber": { "description": "Asset serial number", "example": "8dka2810", "type": "string" }, "cable": { "$ref": "#/components/schemas/V1Asset_cable" }, "engineHours": { "description": "Engine hours", "example": 104, "type": "integer" }, "id": { "description": "Asset ID", "example": 1, "format": "int64", "type": "integer" }, "location": { "description": "Current location of an asset", "items": { "$ref": "#/components/schemas/V1AssetCurrentLocation" }, "type": "array" }, "name": { "description": "Asset name", "example": "Trailer 123", "type": "string" } }, "required": [ "id" ], "type": "object" }, "V1AssetLocationResponse": { "description": "A list of historical asset locations.", "items": { "description": "Asset location details.", "properties": { "latitude": { "description": "The latitude of the location in degrees.", "example": 37, "type": "number" }, "location": { "description": "The best effort (street,city,state) for the latitude and longitude.", "example": "525 York, San Francisco, CA", "type": "string" }, "longitude": { "description": "The longitude of the location in degrees.", "example": -122.7, "type": "number" }, "speedMilesPerHour": { "description": "The speed calculated from GPS that the asset was traveling at in miles per hour.", "example": 35, "type": "number" }, "time": { "description": "Time in Unix milliseconds since epoch when the asset was at the location.", "example": 12314151, "type": "number" } }, "type": "object" }, "type": "array" }, "V1AssetReeferResponse": { "description": "Reefer-specific asset details", "properties": { "assetType": { "description": "Asset type", "example": "Thermo King", "type": "string" }, "id": { "description": "Asset ID", "example": 1, "type": "integer" }, "name": { "description": "Asset name", "example": "Reefer 123", "type": "string" }, "reeferStats": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats" } }, "type": "object" }, "V1AssetReeferResponse_reeferStats": { "properties": { "alarms": { "description": "Reefer alarms", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_alarms_1" }, "type": "array" }, "engineHours": { "description": "Engine hours of the reefer", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_engineHours" }, "type": "array" }, "fuelPercentage": { "description": "Fuel percentage of the reefer", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_fuelPercentage" }, "type": "array" }, "powerStatus": { "description": "Power status of the reefer", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_powerStatus" }, "type": "array" }, "returnAirTemp": { "description": "Return air temperature of the reefer", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_returnAirTemp" }, "type": "array" }, "setPoint": { "description": "Set point temperature of the reefer", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_setPoint" }, "type": "array" } }, "type": "object" }, "V1AssetReeferResponse_reeferStats_alarms": { "properties": { "alarmCode": { "description": "ID of the alarm", "example": 102, "format": "int64", "type": "integer" }, "description": { "description": "Description of the alarm", "example": "Check Return Air Sensor", "type": "string" }, "operatorAction": { "description": "Recommended operator action", "example": "Check and repair at end of trip", "type": "string" }, "severity": { "description": "Severity of the alarm: 1: OK to run, 2: Check as specified, 3: Take immediate action", "example": 1, "format": "int64", "type": "integer" } }, "type": "object" }, "V1AssetReeferResponse_reeferStats_alarms_1": { "properties": { "alarms": { "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_alarms" }, "type": "array" }, "changedAtMs": { "description": "Timestamp when the alarms were reported, in Unix milliseconds since epoch", "example": 1453449599999, "format": "int64", "type": "integer" } }, "type": "object" }, "V1AssetReeferResponse_reeferStats_engineHours": { "properties": { "changedAtMs": { "description": "Timestamp in Unix milliseconds since epoch.", "example": 1453449599999, "format": "int64", "type": "integer" }, "engineHours": { "description": "Engine hours of the reefer.", "example": 1200, "format": "int64", "type": "integer" } }, "type": "object" }, "V1AssetReeferResponse_reeferStats_fuelPercentage": { "properties": { "changedAtMs": { "description": "Timestamp in Unix milliseconds since epoch.", "example": 1453449599999, "format": "int64", "type": "integer" }, "fuelPercentage": { "description": "Fuel percentage of the reefer.", "example": 99, "format": "int64", "type": "integer" } }, "type": "object" }, "V1AssetReeferResponse_reeferStats_powerStatus": { "properties": { "changedAtMs": { "description": "Timestamp in Unix milliseconds since epoch.", "example": 1453449599999, "format": "int64", "type": "integer" }, "status": { "description": "Power status of the reefer. Valid values: `Off`, `Active`, `Active (Start/Stop)`, `Active (Continuous)`.", "example": "Active (Continuous)", "type": "string" } }, "type": "object" }, "V1AssetReeferResponse_reeferStats_returnAirTemp": { "properties": { "changedAtMs": { "description": "Timestamp in Unix milliseconds since epoch.", "example": 1453449599999, "format": "int64", "type": "integer" }, "tempInMilliC": { "description": "Return air temperature in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" } }, "type": "object" }, "V1AssetReeferResponse_reeferStats_setPoint": { "properties": { "changedAtMs": { "description": "Timestamp in Unix milliseconds since epoch.", "example": 1453449599999, "format": "int64", "type": "integer" }, "tempInMilliC": { "description": "Set point temperature in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" } }, "type": "object" }, "V1Asset_cable": { "description": "The cable connected to the asset", "properties": { "assetType": { "description": "Asset type", "example": "Thermo King", "type": "string" } }, "type": "object" }, "V1AssetsReefer": { "description": "Reefer-specific details", "properties": { "assetType": { "description": "Asset type", "example": "Thermo King", "type": "string" }, "id": { "description": "Asset ID", "example": 1, "type": "integer" }, "name": { "description": "Asset name", "example": "Reefer 123", "type": "string" }, "reeferStats": { "$ref": "#/components/schemas/V1AssetsReefer_reeferStats" } }, "type": "object" }, "V1AssetsReefer_reeferStats": { "description": "Contains all the state changes of the reefer for the included stat types. Each state change is recorded independently, so the number of records in each array may differ depending on when that stat changed state. Stat types with a continuous value (such as temperature) will be recorded at different rates depending on the reefer, but generally readings have a frequency on the order of seconds.", "properties": { "ambientAirTemperature": { "description": "Ambient temperature of the reefer. This is the temperature of the air around the Samsara Asset Gateway.", "items": { "$ref": "#/components/schemas/V1AssetsReefer_reeferStats_ambientAirTemperature" }, "type": "array" }, "dischargeAirTemperature": { "description": "Discharge air temperature of the reefer. This is the temperature of the air as it leaves the cooling unit.", "items": { "$ref": "#/components/schemas/V1AssetsReefer_reeferStats_dischargeAirTemperature" }, "type": "array" }, "engineHours": { "description": "Engine hours of the reefer", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_engineHours" }, "type": "array" }, "fuelPercentage": { "description": "Fuel percentage of the reefer", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_fuelPercentage" }, "type": "array" }, "powerStatus": { "description": "Power status of the reefer", "items": { "$ref": "#/components/schemas/V1AssetsReefer_reeferStats_powerStatus" }, "type": "array" }, "reeferAlarms": { "description": "Reefer alarms", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_alarms_1" }, "type": "array" }, "returnAirTemperature": { "description": "Return air temperature of the reefer. This is the temperature read by the reefer module (Carrier, Thermo King) that shows the temperature of the air as it enters the system.", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_returnAirTemp" }, "type": "array" }, "setPoint": { "description": "Set point temperature of the reefer", "items": { "$ref": "#/components/schemas/V1AssetReeferResponse_reeferStats_setPoint" }, "type": "array" } }, "type": "object" }, "V1AssetsReefer_reeferStats_ambientAirTemperature": { "properties": { "changedAtMs": { "description": "Timestamp in Unix milliseconds since epoch.", "example": 1453449599999, "format": "int64", "type": "integer" }, "tempInMilliC": { "description": "Ambient temperature in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" } }, "type": "object" }, "V1AssetsReefer_reeferStats_dischargeAirTemperature": { "properties": { "changedAtMs": { "description": "Timestamp in Unix milliseconds since epoch.", "example": 1453449599999, "format": "int64", "type": "integer" }, "tempInMilliC": { "description": "Discharge temperature in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" } }, "type": "object" }, "V1AssetsReefer_reeferStats_powerStatus": { "properties": { "changedAtMs": { "description": "Timestamp in Unix milliseconds since epoch.", "example": 1453449599999, "format": "int64", "type": "integer" }, "status": { "description": "Power status of the reefer. Valid values: `Off`, `Active`, `Active (Start/Stop)`, `Active (Continuous)`.", "enum": [ "Off", "Active", "Active (Start/Stop)", "Active (Continuous)" ], "example": "Active (Continuous)", "type": "string" } }, "type": "object" }, "V1CargoResponse": { "description": "Contains the current cargo status of a sensor.", "properties": { "groupId": { "description": "Deprecated.", "example": 101, "format": "int64", "type": "integer" }, "sensors": { "items": { "$ref": "#/components/schemas/V1CargoResponse_sensors" }, "type": "array" } }, "type": "object" }, "V1CargoResponse_sensors": { "properties": { "cargoEmpty": { "description": "Flag indicating whether the current cargo is empty or loaded.", "example": true, "type": "boolean" }, "cargoStatusTime": { "description": "The timestamp of reported cargo status, specified in RFC 3339 time.", "example": "2019-04-17T16:42:55Z", "type": "string" }, "id": { "description": "ID of the sensor.", "example": 122, "format": "int64", "type": "integer" }, "name": { "description": "Name of the sensor.", "example": "Trailer Cargo V1Sensor", "type": "string" }, "redEyeDistance": { "description": "The distance between red eye detector and the closest object in cm.", "example": 175, "type": "integer" }, "trailerId": { "description": "ID of the trailer associated with the sensor for the data point. If no trailer is connected, this parameter will not be reported.", "example": 123, "type": "integer" }, "vehicleId": { "description": "ID of the vehicle associated with the sensor for the data point. If no vehicle is connected, this parameter will not be reported.", "example": 124, "type": "integer" } }, "type": "object" }, "V1DataInputHistoryResponse": { "properties": { "id": { "description": "The ID of this data input", "example": 12345, "format": "int64", "type": "integer" }, "name": { "description": "Name of this data input", "example": "Pump Flow", "type": "string" }, "points": { "description": "Data points from this data input", "items": { "$ref": "#/components/schemas/V1DataInputHistoryResponse_points" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "V1DataInputHistoryResponse_points": { "properties": { "timeMs": { "example": 1453449599999, "format": "int64", "type": "integer" }, "value": { "example": 12.332, "format": "double", "type": "number" } }, "type": "object" }, "V1DispatchJob": { "allOf": [ { "$ref": "#/components/schemas/V1DispatchJob_allOf" }, { "$ref": "#/components/schemas/V1DispatchJobCreate" } ] }, "V1DispatchJobCreate": { "properties": { "destination_address": { "description": "The address of the job destination, as it would be recognized if provided to maps.google.com. Optional if a valid destination address ID is provided.", "example": "123 Main St, Philadelphia, PA 19106", "type": "string" }, "destination_address_id": { "description": "ID of the job destination associated with an address book entry. Optional if valid values are provided for destination address and latitude/longitude. If a valid destination address ID is provided, address/latitude/longitude will be used from the address book entry. Name of the address book entry will only be used if the destination name is not provided.", "example": 67890, "format": "int64", "type": "integer" }, "destination_lat": { "description": "Latitude of the destination in decimal degrees. Optional if a valid destination address ID is provided.", "example": 123.456, "format": "double", "type": "number" }, "destination_lng": { "description": "Longitude of the destination in decimal degrees. Optional if a valid destination address ID is provided.", "example": 37.459, "format": "double", "type": "number" }, "destination_name": { "description": "The name of the job destination. If provided, it will take precedence over the name of the address book entry.", "example": "ACME Inc. Philadelphia HQ", "type": "string" }, "external_ids": { "$ref": "#/components/schemas/V1DispatchRouteJobExternalIds" }, "notes": { "description": "Notes regarding the details of this job, maximum of 2000 characters; newline characters ('\\n')can be used for formatting.", "example": "Ensure crates are stacked no more than 3 high.", "type": "string" }, "scheduled_arrival_time_ms": { "description": "The time at which the assigned driver is scheduled to arrive at the job destination.", "example": 1462881998034, "format": "int64", "type": "integer" }, "scheduled_departure_time_ms": { "description": "The time at which the assigned driver is scheduled to depart from the job destination.", "example": 1462881998034, "format": "int64", "type": "integer" } }, "required": [ "scheduled_arrival_time_ms" ], "type": "object" }, "V1DispatchJobDocumentInfo": { "properties": { "driverId": { "description": "ID of driver that submitted the document.", "example": 1234, "type": "integer" }, "id": { "description": "ID of document. This can be used to query for the document's info via the /v1/fleet/drivers/{driver_id}/documents/{document_id} endpoint", "example": "2018_42424242", "type": "string" } }, "required": [ "driverId", "id" ], "type": "object" }, "V1DispatchJobWithoutETA": { "allOf": [ { "$ref": "#/components/schemas/V1DispatchJobWithoutETA_allOf" }, { "$ref": "#/components/schemas/V1DispatchJobCreate" } ] }, "V1DispatchJobWithoutETA_allOf": { "properties": { "arrived_at_ms": { "description": "The time at which the driver arrived at the job destination.", "example": 1462881998034, "format": "int64", "type": "integer" }, "completed_at_ms": { "description": "The time at which the job was marked complete (e.g. started driving to the next destination).", "example": 1462881998034, "format": "int64", "type": "integer" }, "dispatch_route_id": { "description": "ID of the route that this job belongs to.", "example": 55, "format": "int64", "type": "integer" }, "documents": { "description": "Document submissions associated with this job.", "items": { "$ref": "#/components/schemas/V1DispatchJobDocumentInfo" }, "type": "array" }, "driver_id": { "description": "ID of the driver assigned to the dispatch job.", "example": 444, "format": "int64", "type": "integer" }, "en_route_at_ms": { "description": "The time at which the assigned driver started fulfilling the job (e.g. started driving to the destination).", "example": 1462881998034, "format": "int64", "type": "integer" }, "fleet_viewer_url": { "description": "Fleet viewer url of the dispatch job.", "example": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token", "type": "string" }, "group_id": { "description": "Deprecated.", "example": 101, "format": "int64", "type": "integer" }, "id": { "description": "ID of the Samsara dispatch job.", "example": 773, "format": "int64", "type": "integer" }, "job_state": { "$ref": "#/components/schemas/V1JobStatus" }, "skipped_at_ms": { "description": "The time at which the job was marked skipped.", "example": 1462881998034, "format": "int64", "type": "integer" }, "vehicle_id": { "description": "ID of the vehicle used for the dispatch job.", "example": 112, "format": "int64", "type": "integer" } }, "required": [ "dispatch_route_id", "id", "job_state" ], "type": "object" }, "V1DispatchJob_allOf": { "properties": { "arrived_at_ms": { "description": "The time at which the driver arrived at the job destination.", "example": 1462881998034, "format": "int64", "type": "integer" }, "completed_at_ms": { "description": "The time at which the job was marked complete (e.g. started driving to the next destination).", "example": 1462881998034, "format": "int64", "type": "integer" }, "dispatch_route_id": { "description": "ID of the route that this job belongs to.", "example": 55, "format": "int64", "type": "integer" }, "documents": { "description": "Document submissions associated with this job.", "items": { "$ref": "#/components/schemas/V1DispatchJobDocumentInfo" }, "type": "array" }, "driver_id": { "description": "ID of the driver assigned to the dispatch job.", "example": 444, "format": "int64", "type": "integer" }, "en_route_at_ms": { "description": "The time at which the assigned driver started fulfilling the job (e.g. started driving to the destination).", "example": 1462881998034, "format": "int64", "type": "integer" }, "estimated_arrival_ms": { "description": "The time at which the assigned driver is estimated to arrive at the job destination. Only valid for en-route jobs.", "example": 1462881998034, "format": "int64", "type": "integer" }, "fleet_viewer_url": { "description": "Fleet viewer url of the dispatch job.", "example": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token", "type": "string" }, "group_id": { "description": "Deprecated.", "example": 101, "format": "int64", "type": "integer" }, "id": { "description": "ID of the Samsara dispatch job.", "example": 773, "format": "int64", "type": "integer" }, "job_state": { "$ref": "#/components/schemas/V1JobStatus" }, "skipped_at_ms": { "description": "The time at which the job was marked skipped.", "example": 1462881998034, "format": "int64", "type": "integer" }, "vehicle_id": { "description": "ID of the vehicle used for the dispatch job.", "example": 112, "format": "int64", "type": "integer" } }, "required": [ "dispatch_route_id", "id", "job_state" ], "type": "object" }, "V1DispatchRoute": { "allOf": [ { "$ref": "#/components/schemas/V1DispatchRoute_allOf" }, { "$ref": "#/components/schemas/V1DispatchRouteBase" } ] }, "V1DispatchRouteBase": { "properties": { "actual_end_ms": { "description": "The time in Unix epoch milliseconds that the route actually ended.", "example": 1462882101000, "format": "int64", "type": "integer" }, "actual_start_ms": { "description": "The time in Unix epoch milliseconds that the route actually started.", "example": 1462882098000, "format": "int64", "type": "integer" }, "complete_last_stop_on_arrival": { "default": true, "description": "When set to true (default), this causes the Route to complete on arrival at the final stop. When set to false, the last stop will capture arrival and departure separately as with other stops.", "type": "boolean" }, "driver_id": { "description": "ID of the driver assigned to the dispatch route. Note that driver_id and vehicle_id are mutually exclusive. If neither is specified, then the route is unassigned.", "example": 555, "format": "int64", "type": "integer" }, "externalIds": { "$ref": "#/components/schemas/V1DispatchRouteExternalIds" }, "group_id": { "description": "Deprecated.", "example": 101, "format": "int64", "type": "integer" }, "name": { "description": "Descriptive name of this route.", "example": "Bid #123", "type": "string" }, "notes": { "description": "Notes regarding the details of this route; maximum of 2000 characters; newline characters ('\\n')can be used for formatting.", "example": "Please make sure to confirm crate count at each stop on this route.\nTotal number of crates for route: 23.", "type": "string" }, "odometer_end_meters": { "description": "Odometer reading at the end of the route. Will not be returned if Route is not completed or if Odometer information is not available for the relevant vehicle.", "example": 2000000, "format": "int64", "type": "integer" }, "odometer_start_meters": { "description": "Odometer reading at the start of the route. Will not be returned if Route has not started or if Odometer information is not available for the relevant vehicle.", "example": 1000000, "format": "int64", "type": "integer" }, "scheduled_end_ms": { "description": "The time in Unix epoch milliseconds that the last job in the route is scheduled to end.", "example": 1462881998034, "format": "int64", "type": "integer" }, "scheduled_meters": { "description": "The distance expected to be traveled for this route in meters.", "example": 10000, "format": "int64", "type": "integer" }, "scheduled_start_ms": { "description": "The time in Unix epoch milliseconds that the route is scheduled to start.", "example": 1462881998034, "format": "int64", "type": "integer" }, "start_location_address": { "description": "The address of the route's starting location, as it would be recognized if provided to maps.google.com. Optional if a valid start location address ID is provided.", "example": "123 Main St, Philadelphia, PA 19106", "type": "string" }, "start_location_address_id": { "description": "ID of the start location associated with an address book entry. Optional if valid values are provided for start location address and latitude/longitude. If a valid start location address ID is provided, address/latitude/longitude will be used from the address book entry. Name of the address book entry will only be used if the start location name is not provided.", "example": 67890, "format": "int64", "type": "integer" }, "start_location_lat": { "description": "Latitude of the start location in decimal degrees. Optional if a valid start location address ID is provided.", "example": 123.456, "format": "double", "type": "number" }, "start_location_lng": { "description": "Longitude of the start location in decimal degrees. Optional if a valid start location address ID is provided.", "example": 37.459, "format": "double", "type": "number" }, "start_location_name": { "description": "The name of the route's starting location. If provided, it will take precedence over the name of the address book entry.", "example": "ACME Inc. Philadelphia HQ", "type": "string" }, "trailer_id": { "description": "ID of the trailer assigned to the dispatch route. Note that trailers can only be assigned to routes that have a Vehicle or Driver assigned to them.", "example": 666, "format": "int64", "type": "integer" }, "vehicle_id": { "description": "ID of the vehicle assigned to the dispatch route. Note that vehicle_id and driver_id are mutually exclusive. If neither is specified, then the route is unassigned.", "example": 444, "format": "int64", "type": "integer" } }, "type": "object" }, "V1DispatchRouteExternalIds": { "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "V1DispatchRouteHistoricalEntry": { "properties": { "changed_at_ms": { "description": "Timestamp that the route was updated, represented as Unix milliseconds since epoch.", "example": 1499411220000, "format": "int64", "type": "integer" }, "route": { "$ref": "#/components/schemas/V1DispatchRoute" } }, "type": "object" }, "V1DispatchRouteHistory": { "properties": { "history": { "description": "History of the route's state changes.", "items": { "$ref": "#/components/schemas/V1DispatchRouteHistoricalEntry" }, "type": "array" } }, "type": "object" }, "V1DispatchRouteJobExternalIds": { "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "V1DispatchRouteWithoutETA": { "allOf": [ { "$ref": "#/components/schemas/V1DispatchRouteWithoutETA_allOf" }, { "$ref": "#/components/schemas/V1DispatchRouteBase" } ] }, "V1DispatchRouteWithoutETA_allOf": { "properties": { "dispatch_jobs": { "description": "The dispatch jobs associated with this route.", "items": { "$ref": "#/components/schemas/V1DispatchJobWithoutETA" }, "type": "array" }, "id": { "description": "ID of the Samsara dispatch route.", "example": 556, "format": "int64", "type": "integer" } }, "type": "object" }, "V1DispatchRoute_allOf": { "properties": { "dispatch_jobs": { "description": "The dispatch jobs associated with this route.", "items": { "$ref": "#/components/schemas/V1DispatchJob" }, "type": "array" }, "id": { "description": "ID of the Samsara dispatch route.", "example": 556, "format": "int64", "type": "integer" } }, "type": "object" }, "V1DispatchRoutes": { "items": { "$ref": "#/components/schemas/V1DispatchRouteWithoutETA" }, "type": "array" }, "V1Document": { "allOf": [ { "$ref": "#/components/schemas/V1Document_allOf" }, { "$ref": "#/components/schemas/V1DocumentBase" } ] }, "V1DocumentBase": { "properties": { "dispatchJobId": { "description": "ID of the Samsara dispatch job for which the document is submitted.", "example": 773, "format": "int64", "type": "integer" }, "name": { "description": "Custom name of the document. If no custom name is given to the document, the admin dashboard and driver app will display the template name as the default document name.", "example": "Fuel Receipt Wichita", "maxLength": 255, "minLength": 1, "type": "string" }, "notes": { "description": "Notes submitted with this document.", "example": "Fueled up before delivery.", "type": "string" }, "state": { "default": "Required", "description": "The condition of the document created for the driver. Can be either `Required` or `Submitted`. If no value is specified, `state` defaults to `Required`. `Required` documents are pre-populated documents for the Driver to fill out in the Driver App and have not yet been submitted. `Submitted` documents have been submitted by the driver in the Driver App. `Archived` documents have been archived by the admin in the cloud dashboard.", "enum": [ "Required", "Submitted", "Archived" ], "example": "Submitted", "type": "string" } }, "required": [ "dispatchJobId", "notes" ], "type": "object" }, "V1DocumentConditionalFields": { "description": "An array of objects that describe a set of fields conditionally shown by a multiple choice value.", "example": [ { "conditionalFieldFirstIndex": 1, "conditionalFieldLastIndex": 4, "triggeringFieldIndex": 0, "triggeringFieldValue": "Yes" } ], "items": { "properties": { "conditionalFieldIndexFirst": { "description": "Start index of the conditional fields set", "type": "number" }, "conditionalFieldIndexLast": { "description": "End index of the conditional fields set", "type": "number" }, "triggeringFieldIndex": { "description": "Index of the multiple choice field that triggers the conditional fields", "type": "number" }, "triggeringFieldValue": { "description": "Multiple choice value that triggers the conditional fields", "type": "string" } }, "type": "object" }, "type": "array" }, "V1DocumentCreate": { "allOf": [ { "$ref": "#/components/schemas/V1DocumentCreate_allOf" }, { "$ref": "#/components/schemas/V1DocumentCreateBase" } ] }, "V1DocumentCreateBase": { "properties": { "dispatchJobId": { "description": "ID of the Samsara dispatch job for which the document is submitted.", "example": 773, "format": "int64", "type": "integer" }, "name": { "description": "Custom name of the document. If no custom name is given to the document, the admin dashboard and driver app will display the template name as the default document name.", "example": "Fuel Receipt Wichita", "maxLength": 255, "minLength": 1, "type": "string" }, "notes": { "description": "Notes submitted with this document.", "example": "Fueled up before delivery.", "type": "string" }, "state": { "default": "Required", "description": "The condition of the document created for the driver. Can be either `Required` or `Submitted`. If no value is specified, `state` defaults to `Required`. `Required` documents are pre-populated documents for the Driver to fill out in the Driver App and have not yet been submitted. `Submitted` documents will show up as submitted by the driver through the driver app.", "enum": [ "Required", "Submitted" ], "example": "Required", "type": "string" } }, "type": "object" }, "V1DocumentCreateFields": { "description": "List of fields for the document. The fields must be listed in the order that that they appear in the document type. Values of fields can be set to null or omitted if the document state is set to \"Required\".", "example": [ { "label": "Example number field label", "numberValue": 999, "valueType": "ValueType_Number" }, { "label": "text", "stringValue": "example string", "valueType": "ValueType_String" }, { "label": "Example multi choice label", "multipleChoiceValue": [ { "selected": false, "value": "option 1" }, { "selected": true, "value": "option 2" } ], "valueType": "ValueType_MultipleChoice" }, { "dateTimeValue": { "dateTimeMs": 10855639004823 }, "label": "Example date time label", "valueType": "ValueType_DateTime" }, { "label": "Example photo label", "valueType": "ValueType_Photo" }, { "label": "Example signature label", "valueType": "ValueType_Signature" } ], "items": { "description": "Field item parameters.", "properties": { "dateTimeValue": { "description": "The date time value to populate the field. Use with ValueType_DateTime. Cannot be ommited or set to null", "properties": { "dateTimeMs": { "type": "number" } }, "type": "object" }, "label": { "description": "label of the field", "type": "string" }, "multipleChoiceValue": { "description": "The multiple choice value to populate the field. Use with ValueType_MultipleChoice. Cannot be ommited or set to null", "items": { "description": "An option item for a multiple choice field", "properties": { "selected": { "type": "boolean" }, "value": { "type": "string" } }, "type": "object" }, "type": "array" }, "numberValue": { "description": "The number value to populate the field. Use with ValueType_Number. Can be ommited or set to null", "type": "number" }, "stringValue": { "description": "The string value to populate the field. Use with ValueType_String. Can be ommited or set to null", "type": "string" }, "value": { "description": "DEPRECATED. Please use one of the type-specific parameters.", "type": "object" }, "valueType": { "description": "The valueType of the field. Use with the corresponding {type of field}Value attribute. Signature and photo fields do not support values added via API. Their values must be omitted or set to null. For example:\n\n```\n\n\"fields\": [\n\n {\n\n \"label\": \"Signature\",\n\n \"valueType\": \"ValueType_Signature\"\n\n },\n\n ... more fields\n\n]\n\n```", "type": "string" } }, "required": [ "label", "valueType" ], "type": "object" }, "type": "array" }, "V1DocumentCreate_allOf": { "description": "Arguments to create a document.", "properties": { "documentTypeUuid": { "description": "Universally unique identifier for the document type that this document is being created for.", "example": "4aff772c-a7bb-45e6-8e41-6a53e34feb83", "type": "string" }, "fields": { "$ref": "#/components/schemas/V1DocumentCreateFields" } }, "required": [ "documentTypeUuid", "fields" ], "type": "object" }, "V1DocumentFieldType": { "properties": { "label": { "description": "Name of this field type.", "example": "Fuel Cost ($)", "type": "string" }, "multipleChoiceValueTypeMetadata": { "$ref": "#/components/schemas/V1DocumentFieldType_multipleChoiceValueTypeMetadata" }, "numberValueTypeMetadata": { "$ref": "#/components/schemas/V1DocumentFieldType_numberValueTypeMetadata" }, "signatureValueTypeMetadata": { "$ref": "#/components/schemas/V1DocumentFieldType_signatureValueTypeMetadata" }, "valueType": { "description": "The type of value this field can have.\nValid values: `ValueType_Number`, `ValueType_String`, `ValueType_Photo`, `ValueType_MultipleChoice`, `ValueType_Signature`, `ValueType_DateTime`.", "example": "ValueType_Number", "type": "string" } }, "required": [ "label", "valueType" ], "type": "object" }, "V1DocumentFieldType_multipleChoiceValueTypeMetadata": { "description": "Metadata about the multiple choice field. Only present for value type `ValueType_MultipleChoice`", "properties": { "multipleChoiceOptionLabels": { "description": "Array of the multiple choice option labels for the field", "items": { "$ref": "#/components/schemas/V1DocumentFieldType_multipleChoiceValueTypeMetadata_multipleChoiceOptionLabels" }, "type": "array" } }, "type": "object" }, "V1DocumentFieldType_multipleChoiceValueTypeMetadata_multipleChoiceOptionLabels": { "properties": { "label": { "example": "option 1", "type": "string" } }, "type": "object" }, "V1DocumentFieldType_numberValueTypeMetadata": { "description": "Metadata about the number field. Only present for value type `ValueType_Number`", "properties": { "numDecimalPlaces": { "description": "The number of decimal places allowed for this number field", "example": 2, "format": "int64", "type": "number" } }, "type": "object" }, "V1DocumentFieldType_signatureValueTypeMetadata": { "description": "Metadata about the signature field. Only present for value type `ValueType_Signature`", "properties": { "legalText": { "description": "Legal text displayed alongside signature", "example": "I consent on behalf of myself and my employer to using electronic signatures in this transaction. I understand that I can request a copy of the signed documentation from the party requesting my signature.", "type": "string" } }, "type": "object" }, "V1DocumentFields": { "description": "An array of field objects associated with a document.", "example": [ { "label": "Was there an accident?", "multipleChoiceValue": [ { "selected": false, "value": "Yes" }, { "selected": true, "value": "No" } ], "value": [ { "selected": false, "value": "Yes" }, { "selected": true, "value": "No" } ], "valueType": "ValueType_MultipleChoice" }, { "label": "Number of cars involved", "numberValue": 123, "value": 123, "valueType": "ValueType_Number" }, { "label": "Description of Accident", "stringValue": "Example text value", "value": "Example text value", "valueType": "ValueType_String" }, { "label": "Images of the damaged cars", "photoValue": [ { "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456" } ], "value": [ { "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456", "uuid": "f5271458-21f9-4a9f-a290-780c6d8840ff" } ], "valueType": "ValueType_Photo" }, { "barcodeValue": [ { "barcodeType": "org.gs1.EAN-13", "barcodeValue": "0853883003114" }, { "barcodeType": "org.gs1.EAN-13", "barcodeValue": "0036000318036" } ], "label": "Accident Ticket Barcode", "value": [ { "barcodeType": "org.gs1.EAN-13", "barcodeValue": "0853883003114" }, { "barcodeType": "org.gs1.EAN-13", "barcodeValue": "0036000318036" } ], "valueType": "ValueType_Barcode" }, { "dateTimeValue": { "dateTimeMs": 1596681182972 }, "label": "Today's Date", "value": { "dateTimeMs": 1596681182972 }, "valueType": "ValueType_DateTime" }, { "label": "Sign Signature", "signatureValue": { "name": "John Smith", "signedAtMs": 1596681191327, "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456" }, "value": { "name": "John Smith", "signedAtMs": 1596681191327, "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456", "uuid": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7" }, "valueType": "ValueType_Signature" } ], "items": { "properties": { "barcodeValue": { "description": "The value of a barcode scanning field. Only present for barcode scanning fields", "items": { "properties": { "barcodeType": { "description": "The barcode type that was scanned", "type": "string" }, "barcodeValue": { "description": "The captured barcode value", "type": "string" } }, "type": "object" }, "type": "array" }, "dateTimeValue": { "description": "The value of a date time field. Only present for date time fields.", "properties": { "dateTimeMs": { "description": "Date time value in milliseconds.", "type": "number" } }, "type": "object" }, "label": { "description": "The name of a field.", "type": "string" }, "multipleChoiceValue": { "description": "The value of a multiple choice field. Only present for multiple choice fields.", "items": { "properties": { "selected": { "description": "Boolean representing if the choice has been selected.", "type": "boolean" }, "value": { "description": "Description of the choice.", "type": "string" } }, "type": "object" }, "type": "array" }, "numberValue": { "description": "The value of a number field. Only present for number fields.", "format": "float", "type": "number" }, "photoValue": { "description": "The value of a photo or document scanning field. Only present for photo or document scanning fields.", "items": { "properties": { "url": { "description": "Url of the photo.", "type": "string" }, "uuid": { "description": "Uuid of the photo.", "type": "string" } }, "type": "object" }, "type": "array" }, "signatureValue": { "description": "The value of a signature field. Only present for signature fields.", "properties": { "name": { "description": "Name of the signee for a signature field", "type": "string" }, "signedAtMs": { "description": "Date time value in milliseconds of the time a signature was captured.", "type": "number" }, "url": { "description": "Url of a signature field's PNG signature image.", "type": "string" }, "uuid": { "description": "Uuid of a signature field", "type": "string" } }, "type": "object" }, "stringValue": { "description": "The value of a string field. Only present for string fields.", "type": "string" }, "value": { "description": "The value of a field. Type varies by field type.", "type": "object" }, "valueType": { "description": "The value type of a field.", "type": "string" } }, "type": "object" }, "type": "array" }, "V1DocumentType": { "properties": { "fieldTypes": { "description": "The fields associated with this document type.", "items": { "$ref": "#/components/schemas/V1DocumentFieldType" }, "type": "array" }, "name": { "description": "Name of the document type.", "example": "Fuel Receipt", "type": "string" }, "orgId": { "description": "ID for the organization this document belongs to.", "example": 773, "format": "int64", "type": "integer" }, "uuid": { "description": "Universally unique identifier for the document type. Can be passed in as the `documentTypeUuid` when creating a document for this document type.", "example": "4aff772c-a7bb-45e6-8e41-6a53e34feb83", "type": "string" } }, "required": [ "fieldTypes", "orgId", "uuid" ], "type": "object" }, "V1DocumentTypes": { "items": { "$ref": "#/components/schemas/V1DocumentType" }, "type": "array" }, "V1Document_allOf": { "properties": { "conditionalFieldSections": { "$ref": "#/components/schemas/V1DocumentConditionalFields" }, "documentType": { "description": "Name of the document type.", "example": "Accident Report", "type": "string" }, "driverCreatedAtMs": { "description": "The time in Unix epoch milliseconds that the document was created in the driver app.", "example": 1462881998034, "format": "int64", "type": "integer" }, "driverId": { "description": "ID of the driver for whom the document is submitted.", "example": 555, "format": "int64", "type": "integer" }, "fields": { "$ref": "#/components/schemas/V1DocumentFields" }, "id": { "description": "ID of the document.", "example": "2018_42424242", "type": "string" }, "orgId": { "description": "Organization ID that the document belongs to.", "example": 555, "format": "int64", "type": "integer" }, "serverCreatedAtMs": { "description": "The time in Unix epoch milliseconds that the document was received by the server.", "example": 1462881998034, "format": "int64", "type": "integer" }, "serverUpdatedAtMs": { "description": "The time in Unix epoch milliseconds that the document was updated on the server.", "example": 1462881998034, "format": "int64", "type": "integer" }, "vehicleId": { "description": "ID of the vehicle the driver was signed into when the document was submitted. Will be `null` if the document `state` is `Required`.", "example": 222, "format": "int64", "type": "integer" } }, "required": [ "documentType", "driverCreatedAtMs", "driverId", "fields", "id", "orgId", "serverCreatedAtMs", "serverUpdatedAtMs", "vehicleId" ], "type": "object" }, "V1Documents": { "description": "List of documents.", "properties": { "driverDocuments": { "description": "List of documents.", "items": { "$ref": "#/components/schemas/V1Document" }, "type": "array" } }, "type": "object" }, "V1DoorResponse": { "description": "Contains the current door status of a sensor.", "properties": { "groupId": { "description": "Deprecated.", "example": 101, "format": "int64", "type": "integer" }, "sensors": { "items": { "$ref": "#/components/schemas/V1DoorResponse_sensors" }, "type": "array" } }, "type": "object" }, "V1DoorResponse_sensors": { "properties": { "doorClosed": { "description": "Flag indicating whether the current door is closed or open.", "example": true, "type": "boolean" }, "doorStatusTime": { "description": "The timestamp of reported door status, specified in RFC 3339 time.", "example": "2019-04-17T16:42:55Z", "type": "string" }, "id": { "description": "ID of the sensor.", "example": 122, "format": "int64", "type": "integer" }, "name": { "description": "Name of the sensor.", "example": "Trailer Door V1Sensor", "type": "string" }, "trailerId": { "description": "ID of the trailer associated with the sensor for the data point. If no trailer is connected, this parameter will not be reported.", "example": 123, "type": "integer" }, "vehicleId": { "description": "ID of the vehicle associated with the sensor for the data point. If no vehicle is connected, this parameter will not be reported.", "example": 124, "type": "integer" } }, "type": "object" }, "V1DriverDailyLogResponse": { "properties": { "days": { "items": { "$ref": "#/components/schemas/V1DriverDailyLogResponse_days" }, "type": "array" } }, "type": "object" }, "V1DriverDailyLogResponse_days": { "properties": { "activeHours": { "description": "Hours spent on duty or driving, rounded to two decimal places.", "example": 5.4, "format": "double", "type": "number" }, "activeMs": { "description": "Milliseconds spent on duty or driving.", "example": 691200, "format": "int64", "type": "integer" }, "certified": { "description": "Whether this HOS day chart was certified by the driver.", "type": "boolean" }, "certifiedAtMs": { "description": "Unix epoch time (in ms) of time when this chart was certified. If this chart is uncertified, 0.", "format": "int64", "type": "number" }, "distanceMiles": { "description": "Distance driven in miles, rounded to two decimal places.", "example": 123.24, "format": "double", "type": "number" }, "endMs": { "description": "End of the HOS day, specified in milliseconds UNIX time.", "example": 1473836400000, "type": "integer" }, "shippingDocIds": { "description": "List of customer shipping document IDs associated with the driver for the day.", "example": [ "14334", "Shipping Document ID 1" ], "items": { "type": "string" }, "type": "array" }, "startMs": { "description": "Start of the HOS day, specified in milliseconds UNIX time.", "example": 1473750000000, "type": "integer" }, "trailerIds": { "description": "List of trailer ID's associated with the driver for the day.", "example": [ "10293", "Trailer ID 1" ], "items": { "type": "string" }, "type": "array" }, "vehicleIds": { "description": "List of vehicle ID's associated with the driver for the day.", "example": [192319, 12958], "properties": { }, "type": "object" } }, "type": "object" }, "V1DriverSafetyScoreResponse": { "description": "Safety score details for a driver", "properties": { "crashCount": { "description": "Crash event count", "example": 0, "type": "integer" }, "driverId": { "description": "Driver ID", "example": 1234, "type": "integer" }, "harshAccelCount": { "description": "Harsh acceleration event count", "example": 1, "type": "integer" }, "harshBrakingCount": { "description": "Harsh braking event count", "example": 2, "type": "integer" }, "harshEvents": { "items": { "$ref": "#/components/schemas/V1SafetyReportHarshEvent" }, "type": "array" }, "harshTurningCount": { "description": "Harsh turning event count", "example": 0, "type": "integer" }, "safetyScore": { "description": "The driver’s Safety Score for the requested period. Note that if the driver has zero drive time in this period, the Safety Score will be returned as 100.", "example": 97, "type": "integer" }, "safetyScoreRank": { "description": "Safety Score Rank", "example": "26", "type": "string" }, "timeOverSpeedLimitMs": { "description": "Amount of time driven over the speed limit in milliseconds", "example": 3769, "type": "integer" }, "totalDistanceDrivenMeters": { "description": "Total distance driven in meters", "example": 291836, "type": "integer" }, "totalHarshEventCount": { "description": "Total harsh event count", "example": 3, "type": "integer" }, "totalTimeDrivenMs": { "description": "Amount of time driven in milliseconds", "example": 19708293, "type": "integer" } }, "type": "object" }, "V1DvirBase": { "properties": { "authorSignature": { "$ref": "#/components/schemas/V1DvirBase_authorSignature" }, "defectsCorrected": { "description": "Signifies if the defects on the vehicle corrected after the DVIR is done.", "example": true, "type": "boolean" }, "defectsNeedNotBeCorrected": { "description": "Signifies if the defects on this vehicle can be ignored.", "example": false, "type": "boolean" }, "id": { "description": "The id of this DVIR record.", "example": 19, "format": "int64", "type": "integer" }, "inspectionType": { "description": "Inspection type of the DVIR. Valid values: `preTrip`, `postTrip`, `mechanic`, `unspecified`.", "example": "pre trip", "type": "string" }, "mechanicNotes": { "description": "The mechanics notes on the DVIR.", "example": "The vehicle is now safe.", "type": "string" }, "mechanicOrAgentSignature": { "$ref": "#/components/schemas/V1DvirBase_mechanicOrAgentSignature" }, "nextDriverSignature": { "$ref": "#/components/schemas/V1DvirBase_nextDriverSignature" }, "odometerMiles": { "description": "The odometer reading in miles for the vehicle when the DVIR was done.", "example": 49912, "format": "int64", "type": "integer" }, "startedAtMs": { "description": "Timestamp when driver began filling out this DVIR, in UNIX milliseconds.", "example": 1453449599999, "format": "int64", "type": "integer" }, "timeMs": { "description": "Timestamp of when this DVIR was signed & completed, in UNIX milliseconds.", "example": 1453449599999, "format": "int64", "type": "integer" }, "trailerDefects": { "description": "Defects registered for the trailer which was part of the DVIR.", "items": { "$ref": "#/components/schemas/V1DvirDefectBase" }, "type": "array" }, "trailerId": { "description": "The id of the trailer which was part of the DVIR.", "example": 19, "type": "integer" }, "trailerName": { "description": "The name of the trailer which was part of the DVIR.", "example": "Storer's Trailer 19", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/V1DvirBase_vehicle" }, "vehicleCondition": { "description": "The condition of vechile on which DVIR was done.", "example": "SATISFACTORY", "type": "string" }, "vehicleDefects": { "description": "Defects registered for the vehicle which was part of the DVIR.", "items": { "$ref": "#/components/schemas/V1DvirDefectBase" }, "type": "array" } }, "type": "object" }, "V1DvirBase_authorSignature": { "description": "The authors signature for the DVIR.", "properties": { "driverId": { "description": "ID of the driver who signed the DVIR. Will not be returned if mechanicUserId is returned.", "example": 2581, "format": "int64", "type": "integer" }, "email": { "description": "Email of the driver|mechanic who signed the DVIR.", "example": "j.smith@yahoo.com", "type": "string" }, "mechanicUserId": { "description": "ID of the mechanic who signed the DVIR. Will not be returned if driverId is returned.", "example": 14849, "format": "int64", "type": "integer" }, "name": { "description": "The name of the driver or mechanic who signed the DVIR.", "example": "John Smith", "type": "string" }, "signedAt": { "description": "The time in millis when the DVIR was signed", "example": 12535500000, "format": "int64", "type": "integer" }, "type": { "description": "Type corresponds to whether the signature corresponds to driver|mechanic.", "example": "driver", "type": "string" }, "username": { "description": "Username of the driver|mechanic who signed the DVIR.", "example": "jsmith", "type": "string" } }, "type": "object" }, "V1DvirBase_mechanicOrAgentSignature": { "description": "The mechanic's or agent's signature for the DVIR.", "properties": { "driverId": { "description": "ID of the driver who signed the DVIR. Will not be returned if mechanicUserId is returned.", "example": 2581, "format": "int64", "type": "integer" }, "email": { "description": "Email of the agent|mechanic who signed the DVIR.", "example": "j.smith@yahoo.com", "type": "string" }, "mechanicUserId": { "description": "ID of the mechanic who signed the DVIR. Will not be returned if driverId is returned.", "example": 14849, "format": "int64", "type": "integer" }, "name": { "description": "The name of the agent or mechanic who signed the DVIR.", "example": "John Smith", "type": "string" }, "signedAt": { "description": "The time in millis when the DVIR was signed", "example": 12535500000, "format": "int64", "type": "integer" }, "type": { "description": "Type corresponds to whether the signature corresponds to driver|mechanic.", "example": "driver", "type": "string" }, "username": { "description": "Username of the agent|mechanic who signed the DVIR.", "example": "jsmith", "type": "string" } }, "type": "object" }, "V1DvirBase_nextDriverSignature": { "description": "The next driver signature for the DVIR.", "properties": { "driverId": { "description": "ID of the driver who signed the DVIR", "example": 2581, "format": "int64", "type": "integer" }, "email": { "description": "Email of the driver who signed the next DVIR on this vehicle.", "example": "j.smith@yahoo.com", "type": "string" }, "name": { "description": "The name of the driver who signed the next DVIR on this vehicle.", "example": "John Smith", "type": "string" }, "signedAt": { "description": "The time in millis when the next driver signed the DVIR on this vehicle.", "example": 12535500000, "format": "int64", "type": "integer" }, "type": { "description": "Type corresponds to driver.", "example": "driver", "type": "string" }, "username": { "description": "Username of the driver who signed the next DVIR on this vehicle.", "example": "jsmith", "type": "string" } }, "type": "object" }, "V1DvirBase_vehicle": { "description": "The vehicle on which DVIR was done.", "properties": { "id": { "description": "The vehicle id on which DVIR was done.", "example": 19, "format": "int64", "type": "integer" }, "name": { "description": "The vehicle on which DVIR was done.", "example": "Storer's vehicle 19", "type": "string" } }, "type": "object" }, "V1DvirDefectBase": { "properties": { "comment": { "description": "The comment describing the type of DVIR defect.", "example": "Air Compressor not working", "type": "string" }, "defectType": { "description": "The type of DVIR defect. Possible values: [`AIR_COMPRESSOR`, `AIR_CONDITIONER`, `AIR_LINES`, `BATTERY`, `BELTS_HOSES`, `BRAKE_ACCESSORIES`, `BRAKE_CHECK`, `BRAKE_CONNECTIONS`, `BRAKES`, `CLUTCH`, `COUPLING_DEVICES`, `DEFROSTER_HEATER`, `DOORS`, `DRIVE_LINE`, `EMERGENCY_DOOR_AND_BUZZER`, `ENGINE`, `ENTRANCE_STEPS`, `EXHAUST`, `FIFTH_WHEEL`, `FIRST_AID_KIT`, `FLUID_LEVELS`, `FRAME_ASSEMBLY`, `FRONT_AXLE`, `FUEL_TANKS`, `HORN`, `INTERIOR_AND_FLOOR`, `LANDING_GEAR`, `LIGHTS`, `MIRRORS`, `MUFFLER`, `OIL_PRESSURE`, `OTHER`, `RADIATOR`, `REAR_END`, `REFLECTORS`, `ROOF`, `SAFETY_EQUIPMENT`, `STARTER`, `STEERING`, `STOP_ARM_CONTROL`, `STOP_ARM`, `SUSPENSION`, `TIRE_CHAINS`, `TIRES`, `TRANSMISSION`, `TRIP_RECORDER`, `WHEELS_RIMS`, `WINDOWS`, `WINDSHIELD_WIPERS`, `UNSET`]", "example": "AIR_COMPRESSOR", "type": "string" }, "id": { "description": "The id of this defect.", "example": 18, "format": "int64", "type": "integer" }, "resolved": { "description": "Signifies if this defect is resolved.", "example": true, "type": "boolean" }, "resolvedAt": { "description": "Timestamp when this defect was resolved, in UNIX milliseconds. Will not be returned if the defect is unresolved.", "example": 1453449599999, "format": "int64", "type": "integer" }, "resolvedByDriverId": { "description": "ID of the driver who resolved this defect. Will not be returned if the defect is unresolved or resolvedByMechanicId is returned.", "example": 2581, "format": "int64", "type": "integer" }, "resolvedByMechanicId": { "description": "ID of the mechanic who resolved this defect. Will not be returned if the defect is unresolved or resolvedByDriverId is returned.", "example": 14849, "format": "int64", "type": "integer" } }, "type": "object" }, "V1DvirListResponse": { "properties": { "dvirs": { "items": { "$ref": "#/components/schemas/V1DvirBase" }, "type": "array" } }, "type": "object" }, "V1ErrorResponse": { "description": "Error message describing why the request failed.", "type": "string" }, "V1FleetVehicleLocation": { "description": "Contains the location and speed of a vehicle at a particular time", "properties": { "latitude": { "description": "The latitude of the location in degrees.", "example": 37.2, "format": "double", "type": "number" }, "location": { "description": "The best effort (street,city,state) for the latitude and longitude.", "example": "525 York, San Francisco, CA", "type": "string" }, "longitude": { "description": "The longitude of the location in degrees.", "example": -122.5, "format": "double", "type": "number" }, "speedMilesPerHour": { "description": "The speed calculated from GPS that the asset was traveling at in miles per hour.", "example": 35.2, "format": "double", "type": "number" }, "timeMs": { "description": "Time in Unix milliseconds since epoch when the asset was at the location.", "example": 1535586471332, "format": "int64", "type": "number" } }, "type": "object" }, "V1FleetVehicleLocations": { "items": { "$ref": "#/components/schemas/V1FleetVehicleLocation" }, "type": "array" }, "V1FleetVehiclesLocations": { "items": { "properties": { "id": { "description": "ID of the vehicle.", "example": 112, "format": "int64", "type": "integer" }, "locations": { "$ref": "#/components/schemas/V1FleetVehicleLocations" }, "name": { "description": "Name of the vehicle.", "example": "Truck A7", "type": "string" } }, "type": "object" }, "type": "array" }, "V1HosAuthenticationLogsResponse": { "properties": { "authenticationLogs": { "items": { "$ref": "#/components/schemas/V1HosAuthenticationLogsResponse_authenticationLogs" }, "type": "array" } }, "type": "object" }, "V1HosAuthenticationLogsResponse_authenticationLogs": { "properties": { "actionType": { "description": "The log type - one of 'signin' or 'signout'", "example": "signin", "type": "string" }, "address": { "description": "DEPRECATED: THIS FIELD MAY NOT BE POPULATED", "example": "THIS FIELD MAY NOT BE POPULATED", "type": "string" }, "addressName": { "description": "DEPRECATED: THIS FIELD MAY NOT BE POPULATED", "example": "THIS FIELD MAY NOT BE POPULATED", "type": "string" }, "city": { "description": "DEPRECATED: THIS FIELD MAY NOT BE POPULATED", "example": "THIS FIELD MAY NOT BE POPULATED", "type": "string" }, "happenedAtMs": { "description": "The time at which the event was recorded in UNIX milliseconds.", "example": 1462881998034, "format": "int64", "type": "integer" }, "state": { "description": "DEPRECATED: THIS FIELD MAY NOT BE POPULATED", "example": "THIS FIELD MAY NOT BE POPULATED", "type": "string" } }, "type": "object" }, "V1HosLogsResponse": { "properties": { "logs": { "items": { "$ref": "#/components/schemas/V1HosLogsResponse_logs" }, "type": "array" } }, "type": "object" }, "V1HosLogsResponse_logs": { "properties": { "codriverIds": { "items": { "description": "Ids of codrivers during any of the logged trips", "example": 445, "type": "number" }, "type": "array" }, "driverId": { "description": "ID of the driver.", "example": 444, "format": "int64", "type": "integer" }, "groupId": { "description": "Deprecated.", "example": 101, "format": "int64", "type": "integer" }, "hosStatusType": { "description": "The Hours of Service status type. One of `OFF_DUTY`, `SLEEPER_BED`, `DRIVING`, `ON_DUTY`, `YARD_MOVE`, `PERSONAL_CONVEYANCE`.", "example": "OFF_DUTY", "type": "string" }, "locCity": { "description": "City in which the log was recorded.", "example": "Ahwatukee", "type": "string" }, "locLat": { "description": "Latitude at which the log was recorded.", "example": 23.413702, "format": "float", "type": "number" }, "locLng": { "description": "Longitude at which the log was recorded.", "example": -98.50289, "format": "float", "type": "number" }, "locName": { "description": "Name of location at which the log was recorded.", "example": "McLean Site A", "type": "string" }, "locState": { "description": "State in which the log was recorded.", "example": "Arizona", "type": "string" }, "logStartMs": { "description": "The time at which the log/HOS status started in UNIX milliseconds.", "example": 1462881998034, "format": "int64", "type": "integer" }, "remark": { "description": "Remark associated with the log entry.", "example": "Lunch Break", "type": "string" }, "vehicleId": { "description": "ID of the vehicle.", "example": 112, "format": "int64", "type": "integer" } }, "type": "object" }, "V1HumidityResponse": { "description": "Contains the current humidity of a sensor.", "properties": { "groupId": { "description": "Deprecated.", "example": 101, "format": "int64", "type": "integer" }, "sensors": { "items": { "$ref": "#/components/schemas/V1HumidityResponse_sensors" }, "type": "array" } }, "type": "object" }, "V1HumidityResponse_sensors": { "properties": { "humidity": { "description": "Currently reported relative humidity in percent, from 0-100.", "example": 53, "type": "integer" }, "humidityTime": { "description": "The timestamp of reported relative humidity, specified in RFC 3339 time.", "example": "2019-04-17T16:42:55Z", "type": "string" }, "id": { "description": "ID of the sensor.", "example": 122, "format": "int64", "type": "integer" }, "name": { "description": "Name of the sensor.", "example": "Freezer Humidity V1Sensor", "type": "string" }, "trailerId": { "description": "ID of the trailer associated with the sensor for the data point. If no trailer is connected, this parameter will not be reported.", "example": 123, "type": "integer" }, "vehicleId": { "description": "ID of the vehicle associated with the sensor for the data point. If no vehicle is connected, this parameter will not be reported.", "example": 124, "type": "integer" } }, "type": "object" }, "V1JobStatus": { "description": "The state of the dispatch job.", "enum": [ "JobState_Unassigned", "JobState_Scheduled", "JobState_EnRoute", "JobState_Arrived", "JobState_Completed", "JobState_Skipped" ], "example": "JobState_Arrived", "type": "string" }, "V1Machine": { "description": "Contains information about a machine.", "properties": { "id": { "description": "ID of the machine.", "example": 123, "format": "int64", "type": "integer" }, "name": { "description": "Name of the machine.", "example": "Freezer ABC", "type": "string" }, "notes": { "description": "Notes about the machine", "example": "This is in the left hallway behind the conveyor belt", "type": "string" } }, "required": [ "id" ], "type": "object" }, "V1MachineHistoryResponse": { "description": "Contains the results for a machine history request", "properties": { "machines": { "items": { "$ref": "#/components/schemas/V1MachineHistoryResponse_machines" }, "type": "array" } }, "type": "object" }, "V1MachineHistoryResponse_machines": { "properties": { "id": { "description": "Machine ID", "example": 1, "type": "integer" }, "name": { "description": "Machine name", "example": "1/3 HP Motor", "type": "string" }, "vibrations": { "description": "List of vibration datapoints, with timestamp and vibration measurement for x/y/z axis in mm/s", "items": { "$ref": "#/components/schemas/V1MachineHistoryResponse_vibrations" }, "type": "array" } }, "type": "object" }, "V1MachineHistoryResponse_vibrations": { "properties": { "X": { "example": 0.01, "format": "double", "type": "number" }, "Y": { "example": 1.23, "format": "double", "type": "number" }, "Z": { "example": 2.55, "format": "double", "type": "number" }, "time": { "example": 1453449599999, "format": "int64", "type": "integer" } }, "type": "object" }, "V1Message": { "properties": { "driverId": { "description": "ID of the driver for whom the message is sent to or sent by.", "example": 555, "format": "int64", "type": "integer" }, "text": { "description": "The text sent in the message.", "example": "This is a message.", "type": "string" } }, "required": [ "driverId", "text" ], "type": "object" }, "V1MessageResponse": { "properties": { "driverId": { "description": "ID of the driver for whom the message is sent to or sent by.", "example": 555, "format": "int64", "type": "integer" }, "isRead": { "description": "True if the message was read by the recipient.", "example": true, "type": "boolean" }, "sender": { "$ref": "#/components/schemas/V1MessageSender" }, "sentAtMs": { "description": "The time in Unix epoch milliseconds that the message is sent to the recipient.", "example": 1462881998034, "format": "int64", "type": "integer" }, "text": { "description": "The text sent in the message.", "example": "This is a message.", "type": "string" } }, "required": [ "driverId", "isRead", "sender", "sentAtMs", "text" ], "type": "object" }, "V1MessageSender": { "properties": { "name": { "description": "Name of user that is sending the message.", "example": "John Doe", "type": "string" }, "type": { "description": "Type of user that is sending the message. It will be either dispatch or driver.", "example": "dispatch", "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "V1Messages": { "items": { "$ref": "#/components/schemas/V1Message" }, "type": "array" }, "V1MessagesResponse": { "items": { "$ref": "#/components/schemas/V1MessageResponse" }, "type": "array" }, "V1Pagination": { "properties": { "endCursor": { "description": "Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'startingAfter' query parameter.", "example": "MTU5MTEzNjA2OTU0MzQ3", "type": "string" }, "hasNextPage": { "description": "True if there are more pages of results after this response.", "type": "boolean" }, "hasPrevPage": { "description": "True if there are more pages of results before this response.", "type": "boolean" }, "startCursor": { "description": "Cursor identifier representing the first element in the response. This value should be used in conjunction with a subsequent request's 'ending_before' query parameter.", "example": "MTU5MTEzNjA2OTU0MzQ3", "type": "string" } }, "required": [ "endCursor", "hasNextPage", "hasPrevPage", "startCursor" ], "type": "object" }, "V1ProgramsForTheCameraResponse": { "description": "Contains the list of Programs configured on the given Camera.", "items": { "properties": { "programId": { "example": 1, "format": "int64", "type": "integer" }, "programName": { "example": "Barcode verification program", "type": "string" } }, "type": "object" }, "type": "array" }, "V1SafetyReportHarshEvent": { "description": "List of harsh events", "properties": { "harshEventType": { "description": "Sensor generated harsh event type.", "example": "Harsh Braking", "type": "string" }, "timestampMs": { "description": "Timestamp that the harsh event occurred in Unix milliseconds since epoch", "example": 1535590776000, "type": "integer" }, "vehicleId": { "description": "Vehicle associated with the harsh event", "example": 212014918086169, "type": "integer" } }, "type": "object" }, "V1Sensor": { "description": "Contains information about a sensor.", "properties": { "id": { "description": "ID of the sensor.", "example": 123, "format": "int64", "type": "integer" }, "macAddress": { "description": "MAC address of the sensor.", "example": "11:11:11:11:11:11", "type": "string" }, "name": { "description": "Name of the sensor.", "example": "Freezer ABC", "type": "string" } }, "required": [ "id" ], "type": "object" }, "V1SensorHistoryResponse": { "description": "Contains the results for a sensor history request. Each result contains a timestamp and datapoint for each requested (sensor, field) pair.", "properties": { "results": { "items": { "$ref": "#/components/schemas/V1SensorHistoryResponse_results" }, "type": "array" } }, "type": "object" }, "V1SensorHistoryResponse_results": { "properties": { "series": { "description": "List of datapoints, one for each requested (sensor, field) pair.", "items": { "example": 1, "format": "int64", "type": "integer" }, "type": "array" }, "timeMs": { "description": "Timestamp in UNIX milliseconds.", "example": 1453449599999, "type": "integer" } }, "type": "object" }, "V1TemperatureResponse": { "description": "Contains the current temperatures of a sensor.", "properties": { "groupId": { "description": "Deprecated.", "example": 101, "format": "int64", "type": "integer" }, "sensors": { "items": { "$ref": "#/components/schemas/V1TemperatureResponse_sensors" }, "type": "array" } }, "type": "object" }, "V1TemperatureResponse_sensors": { "properties": { "ambientTemperature": { "description": "Currently reported ambient temperature in millidegrees celsius.", "example": 11057, "type": "integer" }, "ambientTemperatureTime": { "description": "The timestamp of reported ambient temperature, specified in RFC 3339 time.", "example": "2019-04-17T16:42:55Z", "type": "string" }, "id": { "description": "ID of the sensor.", "example": 122, "format": "int64", "type": "integer" }, "name": { "description": "Name of the sensor.", "example": "Freezer Temp V1Sensor", "type": "string" }, "probeTemperature": { "description": "Currently reported probe temperature in millidegrees celsius. If no probe is connected, this parameter will not be reported.", "example": -20145, "type": "integer" }, "probeTemperatureTime": { "description": "The timestamp of reported probe temperature, specified in RFC 3339 time.", "example": "2019-04-17T16:42:55Z", "type": "string" }, "trailerId": { "description": "ID of the trailer associated with the sensor for the data point. If no trailer is connected, this parameter will not be reported.", "example": 123, "type": "integer" }, "vehicleId": { "description": "ID of the vehicle associated with the sensor for the data point. If no vehicle is connected, this parameter will not be reported.", "example": 124, "type": "integer" } }, "type": "object" }, "V1TrailerAssignmentResponse": { "properties": { "driverId": { "description": "The ID of the driver associated with this trailer.", "example": 2047, "format": "int64", "type": "integer" }, "endMs": { "description": "The time at which the driver ended the assignment. If the assignment is current, this value will be omitted.", "example": 1462881998034, "format": "int64", "type": "integer" }, "startMs": { "description": "The time at which the driver started the assignment", "example": 1462878398034, "format": "int64", "type": "integer" } }, "type": "object" }, "V1TrailerAssignmentsResponse": { "allOf": [ { "$ref": "#/components/schemas/V1TrailerBase" }, { "$ref": "#/components/schemas/V1TrailerAssignmentsResponse_allOf" } ] }, "V1TrailerAssignmentsResponse_allOf": { "properties": { "trailerAssignments": { "items": { "$ref": "#/components/schemas/V1TrailerAssignmentResponse" }, "type": "array" } }, "type": "object" }, "V1TrailerBase": { "properties": { "id": { "description": "ID of the trailer", "example": 2041, "format": "int64", "type": "integer" }, "name": { "description": "Assignment trailer name (given when creating trailer via the trailer portal)", "example": "myTrailer", "format": "string", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "V1TripResponse": { "description": "Contains the trips for the vehicle in the requested timeframe. A trip is represented as an object that contains startMs, startLocation, startAddress, startCoordinates, endMs, endLocation, endAddress and endCoordinates. Ongoing trips will be returned with 9223372036854775807 as their endMs.", "properties": { "trips": { "items": { "$ref": "#/components/schemas/V1TripResponse_trips" }, "type": "array" } }, "type": "object" }, "V1TripResponse_endAddress": { "description": "Text representation of nearest identifiable location to the end (latitude, longitude) coordinates.", "properties": { "address": { "description": "The formatted address", "example": "123 Main St, Sunnyvale, CA 94089", "type": "string" }, "id": { "description": "The ID of the address", "example": 581, "format": "int64", "type": "number" }, "name": { "description": "The name of the address", "example": "Ramen Tatsunoya", "type": "string" } }, "type": "object" }, "V1TripResponse_endCoordinates": { "description": "End (latitude, longitude) in decimal degrees.", "properties": { "latitude": { "example": 23.413702345, "format": "double", "type": "number" }, "longitude": { "example": -91.502888123, "format": "double", "type": "number" } }, "type": "object" }, "V1TripResponse_startAddress": { "description": "Text representation of nearest identifiable location to the start (latitude, longitude) coordinates.", "properties": { "address": { "description": "The formatted address", "example": "123 Main St, Sunnyvale, CA 94089", "type": "string" }, "id": { "description": "The ID of the address", "example": 581, "format": "int64", "type": "number" }, "name": { "description": "The name of the address", "example": "Ramen Tatsunoya", "type": "string" } }, "type": "object" }, "V1TripResponse_startCoordinates": { "description": "Start (latitude, longitude) in decimal degrees.", "properties": { "latitude": { "example": 29.443702345, "format": "double", "type": "number" }, "longitude": { "example": -98.502888123, "format": "double", "type": "number" } }, "type": "object" }, "V1TripResponse_trips": { "properties": { "assetIds": { "description": "List of associated asset IDs", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" }, "codriverIds": { "description": "List of codriver IDs", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" }, "distanceMeters": { "description": "Length of the trip in meters. This value is calculated from the GPS data collected by the Samsara Vehicle Gateway.", "example": 2500, "type": "integer" }, "driverId": { "description": "ID of the driver.", "example": 719, "type": "integer" }, "endAddress": { "$ref": "#/components/schemas/V1TripResponse_endAddress" }, "endCoordinates": { "$ref": "#/components/schemas/V1TripResponse_endCoordinates" }, "endLocation": { "description": "Geocoded street address of start (latitude, longitude) coordinates.", "example": "571 S Lake Ave, Pasadena, CA 91101", "type": "string" }, "endMs": { "description": "End of the trip in UNIX milliseconds. Ongoing trips are indicated by an endMs value of 9223372036854775807.", "example": 1462881998034, "type": "integer" }, "endOdometer": { "description": "Odometer reading (in meters) at the end of the trip. This is read from the vehicle's on-board diagnostics. If Samsara cannot read the vehicle's odometer values from on-board diagnostics, this value will be 0.", "example": 210430500, "type": "integer" }, "fuelConsumedMl": { "description": "Amount in milliliters of fuel consumed on this trip.", "example": 75700, "type": "integer" }, "startAddress": { "$ref": "#/components/schemas/V1TripResponse_startAddress" }, "startCoordinates": { "$ref": "#/components/schemas/V1TripResponse_startCoordinates" }, "startLocation": { "description": "Geocoded street address of start (latitude, longitude) coordinates.", "example": "16 N Fair Oaks Ave, Pasadena, CA 91103", "type": "string" }, "startMs": { "description": "Beginning of the trip in UNIX milliseconds.", "example": 1462878398034, "type": "integer" }, "startOdometer": { "description": "Odometer reading (in meters) at the beginning of the trip. This is read from the vehicle's on-board diagnostics. If Samsara cannot read the vehicle's odometer values from on-board diagnostics, this value will be 0.", "example": 210430450, "type": "integer" }, "tollMeters": { "description": "Length in meters trip spent on toll roads.", "example": 32000, "type": "integer" } }, "type": "object" }, "V1VehicleHarshEventResponse": { "description": "Harsh event details for a vehicle", "properties": { "downloadForwardVideoUrl": { "description": "URL for downloading the forward facing video", "example": "https://samsara-dashcam-videos.s3.us-west-2.amazonaws.com/123/212123456789012/1539201872984/abC123De4-camera-video-segment-123456789.mp4?...", "type": "string" }, "downloadInwardVideoUrl": { "description": "URL for downloading the inward facing video", "example": "https://samsara-dashcam-videos.s3.us-west-2.amazonaws.com/123/212123456789012/1539201872984/abC123De4-camera-video-segment-driver-123456789.mp4?...", "type": "string" }, "downloadTrackedInwardVideoUrl": { "description": "URL for downloading the tracked inward facing video", "example": "https://samsara-dashcam-videos.s3.us-west-2.amazonaws.com/123/212123456789012/1539201872984/abC123De4-camera-video-segment-driver-123456789.tracked.mp4?...", "type": "string" }, "harshEventType": { "description": "Type of the harsh event. One of: [Crash, Harsh Acceleration, Harsh Braking, Harsh Turn, ROP Engine, ROP Brake, YC Engine, YC Brake, Harsh Event]", "example": "Harsh Braking", "type": "string" }, "incidentReportUrl": { "description": "URL of the associated incident report page", "example": "https://cloud.samsara.com/o/1234/fleet/reports/safety/vehicle/212123456789012/incident/1539201882984", "type": "string" }, "isDistracted": { "description": "Whether the driver was deemed distracted during this harsh event", "example": true, "type": "boolean" }, "location": { "$ref": "#/components/schemas/V1VehicleHarshEventResponse_location" } }, "required": [ "harshEventType", "incidentReportUrl" ], "type": "object" }, "V1VehicleHarshEventResponse_location": { "properties": { "address": { "description": "Address of location where the harsh event occurred", "example": "350 Rhode Island St, San Francisco, CA", "type": "string" }, "latitude": { "description": "Latitude of location where the harsh event occurred", "example": 33.07614328, "type": "number" }, "longitude": { "description": "Longitude of location where the harsh event occurred", "example": -96.14907287, "type": "number" } }, "type": "object" }, "V1VehicleLocation": { "description": "Contains the location, in latitude and longitude, of a vehicle.", "properties": { "driverId": { "description": "The ID of the driver currently assigned to this vehicle.", "example": 1, "type": "integer" }, "heading": { "description": "Heading in degrees.", "example": 246.42, "format": "double", "type": "number" }, "id": { "description": "ID of the vehicle.", "example": 112, "format": "int64", "type": "integer" }, "latitude": { "description": "Latitude in decimal degrees.", "example": 123.456, "format": "double", "type": "number" }, "location": { "description": "Text representation of nearest identifiable location to (latitude, longitude) coordinates.", "example": "1 Main St, Dallas, TX", "type": "string" }, "longitude": { "description": "Longitude in decimal degrees.", "example": 32.897, "format": "double", "type": "number" }, "name": { "description": "Name of the vehicle.", "example": "Truck A7", "type": "string" }, "odometerMeters": { "description": "The number of meters reported by the odometer.", "example": 71774705, "format": "int64", "type": "integer" }, "odometerType": { "description": "The source of data for odometerMeters. Will be either GPS or OBD", "enum": [ "GPS", "OBD" ], "example": "GPS", "type": "string" }, "onTrip": { "description": "Whether or not a trip is currently in progress for this vehicle. More information available via /fleet/trips endpoint.", "example": true, "type": "boolean" }, "routeIds": { "description": "A list of currently active route IDs that the vehicle is in.", "example": [2244514, 2311654], "items": { "format": "int64", "type": "integer" }, "type": "array" }, "speed": { "description": "Speed in miles per hour.", "example": 64.37, "format": "double", "type": "number" }, "time": { "description": "The time the reported location was logged, reported as a UNIX timestamp in milliseconds.", "example": 1462881998034, "type": "integer" }, "vin": { "description": "Vehicle Identification Number (VIN) of the vehicle.", "example": "JTNBB46KX73011966", "type": "string" } }, "required": [ "id" ], "type": "object" }, "V1VehicleMaintenance": { "description": "Contains any J1939/Passenger engine light warnings and engine faults.", "properties": { "id": { "description": "ID of the vehicle.", "example": 112, "format": "int64", "type": "integer" }, "j1939": { "$ref": "#/components/schemas/V1VehicleMaintenance_j1939" }, "passenger": { "$ref": "#/components/schemas/V1VehicleMaintenance_passenger" } }, "required": [ "id" ], "type": "object" }, "V1VehicleMaintenance_j1939": { "description": "J1939 based data. Null if no data is available.", "properties": { "checkEngineLight": { "$ref": "#/components/schemas/V1VehicleMaintenance_j1939_checkEngineLight" }, "diagnosticTroubleCodes": { "description": "J1939 DTCs.", "items": { "$ref": "#/components/schemas/V1VehicleMaintenance_j1939_diagnosticTroubleCodes" }, "type": "array" } }, "type": "object" }, "V1VehicleMaintenance_j1939_checkEngineLight": { "description": "J1939 check engine lights.", "properties": { "emissionsIsOn": { "type": "boolean" }, "protectIsOn": { "type": "boolean" }, "stopIsOn": { "type": "boolean" }, "warningIsOn": { "type": "boolean" } }, "type": "object" }, "V1VehicleMaintenance_j1939_diagnosticTroubleCodes": { "properties": { "fmiId": { "type": "integer" }, "fmiText": { "type": "string" }, "occurrenceCount": { "type": "integer" }, "spnDescription": { "type": "string" }, "spnId": { "type": "integer" }, "txId": { "type": "integer" } }, "required": [ "fmiId", "fmiText", "occurrenceCount", "spnDescription", "spnId", "txId" ], "type": "object" }, "V1VehicleMaintenance_passenger": { "description": "Passenger vehicle data. Null if no data is available.", "properties": { "checkEngineLight": { "$ref": "#/components/schemas/V1VehicleMaintenance_passenger_checkEngineLight" }, "diagnosticTroubleCodes": { "description": "Passenger vehicle DTCs.", "items": { "$ref": "#/components/schemas/V1VehicleMaintenance_passenger_diagnosticTroubleCodes" }, "type": "array" } }, "type": "object" }, "V1VehicleMaintenance_passenger_checkEngineLight": { "description": "Passenger vehicle check engine light.", "properties": { "isOn": { "type": "boolean" } }, "type": "object" }, "V1VehicleMaintenance_passenger_diagnosticTroubleCodes": { "properties": { "dtcDescription": { "type": "string" }, "dtcId": { "type": "integer" }, "dtcShortCode": { "type": "string" } }, "required": [ "dtcDescription", "dtcId", "dtcShortCode" ], "type": "object" }, "V1VehicleSafetyScoreResponse": { "description": "Safety score details for a vehicle", "properties": { "crashCount": { "description": "Crash event count", "example": 0, "type": "integer" }, "harshAccelCount": { "description": "Harsh acceleration event count", "example": 1, "type": "integer" }, "harshBrakingCount": { "description": "Harsh braking event count", "example": 2, "type": "integer" }, "harshEvents": { "items": { "$ref": "#/components/schemas/V1SafetyReportHarshEvent" }, "type": "array" }, "harshTurningCount": { "description": "Harsh turning event count", "example": 0, "type": "integer" }, "safetyScore": { "description": "The vehicle’s Safety Score for the requested period. Note that if the vehicle has zero drive time in this period, the Safety Score will be returned as 100.", "example": 97, "type": "integer" }, "safetyScoreRank": { "description": "Safety Score Rank", "example": "26", "type": "string" }, "timeOverSpeedLimitMs": { "description": "Amount of time driven over the speed limit in milliseconds", "example": 3769, "type": "integer" }, "totalDistanceDrivenMeters": { "description": "Total distance driven in meters", "example": 291836, "type": "integer" }, "totalHarshEventCount": { "description": "Total harsh event count", "example": 3, "type": "integer" }, "totalTimeDrivenMs": { "description": "Amount of time driven in milliseconds", "example": 19708293, "type": "integer" }, "vehicleId": { "description": "Vehicle ID", "example": 4321, "type": "integer" } }, "type": "object" }, "V1VisionCamerasResponse": { "description": "Contains the list of Cameras installed in the org.", "items": { "properties": { "cameraId": { "example": 1234512345999, "format": "int64", "type": "integer" }, "cameraName": { "example": "Line 32", "type": "string" }, "ethernetIp": { "example": "10.1.2.34", "type": "string" }, "wifiIp": { "example": "10.1.2.35", "type": "string" } }, "type": "object" }, "type": "array" }, "V1VisionRunByCameraResponse": { "properties": { "cameraId": { "example": 1234512345123, "format": "int64", "type": "integer" }, "endedAtMs": { "example": 0, "format": "int64", "type": "integer" }, "inspectionResults": { "items": { "$ref": "#/components/schemas/V1VisionRunByCameraResponse_inspectionResults" }, "type": "array" }, "isOngoing": { "example": true, "type": "boolean" }, "program": { "$ref": "#/components/schemas/V1VisionRunByCameraResponse_program" }, "runSummary": { "$ref": "#/components/schemas/V1VisionRunByCameraResponse_runSummary" }, "startedAtMs": { "example": 1553808606097, "format": "int64", "type": "integer" } }, "type": "object" }, "V1VisionRunByCameraResponse_inspectionResults": { "properties": { "captureAtMs": { "example": 1553811994730, "format": "float64", "type": "number" }, "result": { "example": "PASS", "type": "string" }, "stepResults": { "$ref": "#/components/schemas/V1VisionStepResults" } }, "type": "object" }, "V1VisionRunByCameraResponse_program": { "properties": { "id": { "example": 1, "format": "int64", "type": "integer" }, "name": { "example": "Barcode verification program", "type": "string" } }, "type": "object" }, "V1VisionRunByCameraResponse_runSummary": { "properties": { "itemsPerMinute": { "example": 0.1, "format": "float64", "type": "number" }, "noReadCount": { "example": 0, "format": "int64", "type": "integer" }, "rejectCount": { "example": 0, "format": "int64", "type": "integer" }, "successCount": { "example": 181, "format": "int64", "type": "integer" } }, "type": "object" }, "V1VisionRunsByCameraAndProgramResponse": { "properties": { "deviceId": { "example": 1234512345123, "format": "int64", "type": "integer" }, "endedAtMs": { "example": 0, "format": "int64", "type": "integer" }, "programId": { "example": 1, "format": "int64", "type": "integer" }, "reportMetadata": { "$ref": "#/components/schemas/V1VisionRunByCameraResponse_runSummary" }, "results": { "items": { "$ref": "#/components/schemas/V1VisionRunByCameraResponse_inspectionResults" }, "type": "array" }, "startedAtMs": { "example": 1553808606097, "format": "int64", "type": "integer" } }, "type": "object" }, "V1VisionRunsByCameraResponse": { "items": { "properties": { "deviceId": { "example": 1234512345123, "format": "int64", "type": "integer" }, "endedAtMs": { "example": 0, "format": "int64", "type": "integer" }, "program": { "properties": { "id": { "example": 1, "format": "int64", "type": "integer" }, "name": { "example": "Barcode verification program", "type": "string" } }, "type": "object" }, "reportMetadata": { "properties": { "itemsPerMinute": { "example": 0.1, "format": "float64", "type": "number" }, "noReadCount": { "example": 0, "format": "int64", "type": "integer" }, "rejectCount": { "example": 0, "format": "int64", "type": "integer" }, "successCount": { "example": 181, "format": "int64", "type": "integer" } }, "type": "object" }, "startedAtMs": { "example": 1553808606097, "format": "int64", "type": "integer" } }, "type": "object" }, "type": "array" }, "V1VisionRunsResponse": { "properties": { "visionRuns": { "items": { "$ref": "#/components/schemas/V1VisionRunsResponse_visionRuns" }, "type": "array" } }, "type": "object" }, "V1VisionRunsResponse_reportMetadata": { "description": "The response includes 4 additional fields that are now deprecated", "properties": { "itemsPerMinute": { "description": "Returns average scanned items per minute. Should be used instead of scanRate.", "example": 0.1, "format": "float64", "type": "number" }, "noReadCount": { "description": "Returns no read count for the run. Should be used instead of noReadScansCount", "example": 181, "format": "int64", "type": "integer" }, "rejectCount": { "description": "Returns reject count for the run. Should be used instead of failedScansCount", "example": 0, "format": "int64", "type": "integer" }, "successCount": { "description": "Returns success count for the run. Should be used instead of successfulScansCount", "example": 181, "format": "int64", "type": "integer" } }, "type": "object" }, "V1VisionRunsResponse_visionRuns": { "properties": { "deviceId": { "example": 1234512345123, "format": "int64", "type": "integer" }, "endedAtMs": { "example": 0, "format": "int64", "type": "integer" }, "programId": { "example": 1, "format": "int64", "type": "integer" }, "reportMetadata": { "$ref": "#/components/schemas/V1VisionRunsResponse_reportMetadata" }, "startedAtMs": { "example": 1553808606097, "format": "int64", "type": "integer" } }, "type": "object" }, "V1VisionStepResults": { "items": { "properties": { "angleCheck": { "properties": { "angleConfigured": { "description": "The configured angle allowance range (in degrees)", "properties": { "high": { "example": 150, "format": "int64", "type": "integer" }, "low": { "example": 90, "format": "int64", "type": "integer" } }, "type": "object" }, "angleFound": { "description": "The counter-clockwise angle detected from the first edge to the second edge", "example": 60, "format": "int64", "type": "integer" }, "endStepName": { "description": "The name of the second reference step used to check the angle", "example": "Edge 2", "type": "string" }, "startStepName": { "description": "The name of the first reference step used to check the angle", "example": "Edge 1", "type": "string" } }, "type": "object" }, "barcode": { "items": { "properties": { "contents": { "example": "10855639004823", "type": "string" }, "matchString": { "example": "10855639004823", "type": "string" }, "type": { "example": "EAN8", "type": "string" } }, "type": "object" }, "type": "array" }, "booleanLogic": { "properties": { "operator": { "example": "AND", "type": "string" }, "steps": { "items": { "properties": { "name": { "example": "Expiration Date", "type": "string" }, "result": { "example": "PASS", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "caliper": { "properties": { "angleRange": { "description": "The configured angle allowance range", "properties": { "high": { "example": 360, "format": "int32", "type": "integer" }, "low": { "example": 0, "format": "int32", "type": "integer" } }, "type": "object" }, "contrastRange": { "description": "The configured contrast allowance range", "properties": { "high": { "example": 100, "format": "int64", "type": "integer" }, "low": { "example": 50, "format": "int64", "type": "integer" } }, "type": "object" }, "distanceFound": { "description": "The distance found between the found edges", "example": 555.55, "format": "float", "type": "number" }, "filterPolarity": { "default": "LIGHT TO DARK", "description": "The configured polarity for finding edges. Valid values: `LIGHT TO DARK`, `DARK TO LIGHT`.", "enum": [ "LIGHT TO DARK", "DARK TO LIGHT" ], "example": "LIGHT TO DARK", "type": "string" }, "maxDistance": { "description": "The maximum allowed distance threshold", "example": 1000, "format": "float", "type": "number" }, "minDistance": { "description": "The minumum allowed distance threshold", "example": 500, "format": "float", "type": "number" }, "sharpnessRange": { "description": "The configured sharpness allowance range", "properties": { "high": { "example": 100, "format": "int64", "type": "integer" }, "low": { "example": 80, "format": "int64", "type": "integer" } }, "type": "object" }, "straightnessRange": { "description": "The configured straightness allowance range", "properties": { "high": { "example": 100, "format": "int32", "type": "integer" }, "low": { "example": 80, "format": "int32", "type": "integer" } }, "type": "object" }, "unit": { "description": "The measurement unit of the distance found and the min and max distance threshold", "example": "Millimeters", "type": "string" } }, "type": "object" }, "contour": { "properties": { "angleDegrees": { "description": "The rotation angle found", "example": 0, "format": "int64", "type": "integer" }, "angleTolerance": { "description": "The rotation angle allowance", "example": 50, "format": "int64", "type": "integer" }, "matchPercentage": { "description": "The contour match percentage with the configured contour", "example": 46, "format": "int64", "type": "integer" }, "matchThreshold": { "description": "The configured match threshold for contours", "example": 18, "format": "int64", "type": "integer" } }, "type": "object" }, "distance": { "properties": { "distanceFound": { "description": "The distance found between the start and end references", "format": "float64", "type": "integer" }, "endStepName": { "description": "The name of the second reference step that we're checking the distances between", "example": "Bottom Right Square", "type": "string" }, "enforceOffsetAngleRange": { "description": "Whether an offset angle range is enforced", "example": true, "type": "boolean" }, "maxDistance": { "description": "The maximum allowed distance threshold", "example": 900, "format": "float64", "type": "integer" }, "maxOffsetAngle": { "description": "The maximum angle allowance (in degrees) if enforceOffsetAngleRange is true", "example": 90, "format": "int64", "type": "integer" }, "minDistance": { "description": "The minumum allowed distance threshold", "example": 1500, "format": "float64", "type": "integer" }, "minOffsetAngle": { "description": "The minimum angle allowance (in degrees) if enforceOffsetAngleRange is true", "example": 45, "format": "int64", "type": "integer" }, "offsetAngleFound": { "description": "The counter-clockwise angle (in degrees) found between the horizontal axis of the start reference step and the last", "example": 50, "format": "int64", "type": "integer" }, "startStepName": { "description": "The name of the first reference step that we're checking the distances between", "example": "Top Left Square", "type": "string" }, "unit": { "description": "The measurement unit of the distance found and the min and max distance threshold", "example": "Millimeters", "type": "string" } }, "type": "object" }, "expirationDate": { "properties": { "dateOffset": { "example": 1, "format": "int64", "type": "integer" }, "foundDate": { "example": "06/13/2019", "type": "string" }, "matchDate": { "example": "06/13/2019", "type": "string" } }, "type": "object" }, "findCopies": { "properties": { "angleTolerance": { "description": "The orientation angle tolerance (+/- °)", "example": 10, "format": "int64", "type": "integer" }, "foundCount": { "description": "The number of copies found", "example": 1, "format": "int64", "type": "integer" }, "maxCount": { "description": "The maximum number of copies allowed", "example": 5, "format": "int64", "type": "integer" }, "minCount": { "description": "The minimum number of copies allowed", "example": 1, "format": "int64", "type": "integer" }, "threshold": { "description": "The minimum required similarity (in %) of a found copy compared to the configured match region", "example": 70, "format": "int64", "type": "integer" } }, "type": "object" }, "findEdge": { "properties": { "angleFound": { "description": "The detected angle in degrees", "example": 90, "format": "float64", "type": "integer" }, "angleRange": { "description": "The configured angle allowance range", "properties": { "high": { "example": 360, "format": "int32", "type": "integer" }, "low": { "example": 0, "format": "int32", "type": "integer" } }, "type": "object" }, "contrastPercent": { "description": "The detected contrast percentage", "format": "float64", "type": "integer" }, "contrastRange": { "description": "The configured contrast allowance range", "properties": { "high": { "example": 100, "format": "int64", "type": "integer" }, "low": { "example": 50, "format": "int64", "type": "integer" } }, "type": "object" }, "filterPolarity": { "description": "The configured polarity for finding edges. Valid values: `LIGHT TO DARK`, `DARK TO LIGHT`.", "example": "ANY", "type": "string" }, "sharpnessPercent": { "description": "The detected sharpness percentage", "example": 95, "format": "float64", "type": "integer" }, "sharpnessRange": { "description": "The configured sharpness allowance range", "properties": { "high": { "example": 100, "format": "int64", "type": "integer" }, "low": { "example": 80, "format": "int64", "type": "integer" } }, "type": "object" }, "straightnessFound": { "description": "The detected straightness percentage", "example": 95, "format": "float64", "type": "integer" }, "straightnessRange": { "description": "The configured straightness allowance range", "properties": { "high": { "example": 100, "format": "int32", "type": "integer" }, "low": { "example": 80, "format": "int32", "type": "integer" } }, "type": "object" } }, "type": "object" }, "findShapes": { "properties": { "foundCount": { "example": 1, "format": "int32", "type": "integer" }, "maxCount": { "example": 5, "format": "int32", "type": "integer" }, "minCount": { "example": 1, "format": "int32", "type": "integer" } }, "type": "object" }, "fixture": { "properties": { "coordinates": { "properties": { "x": { "example": 10, "format": "int32", "type": "integer" }, "y": { "example": 10, "format": "int32", "type": "integer" } }, "type": "object" }, "found": { "example": true, "type": "boolean" }, "rotationDegrees": { "example": 90, "format": "int64", "type": "integer" } }, "type": "object" }, "labelMatch": { "properties": { "score": { "example": 10, "format": "int64", "type": "integer" }, "threshold": { "example": 10, "format": "int64", "type": "integer" } }, "type": "object" }, "name": { "example": "Chicken Caesar Label", "type": "string" }, "presenceAbsence": { "properties": { "blueRange": { "properties": { "high": { "example": 150, "format": "int64", "type": "integer" }, "low": { "example": 90, "format": "int64", "type": "integer" } }, "type": "object" }, "checkForAbsence": { "example": true, "type": "boolean" }, "grayscaleRange": { "properties": { "high": { "example": 100, "format": "int64", "type": "integer" }, "low": { "example": 20, "format": "int64", "type": "integer" } }, "type": "object" }, "greenRange": { "properties": { "high": { "example": 150, "format": "int64", "type": "integer" }, "low": { "example": 90, "format": "int64", "type": "integer" } }, "type": "object" }, "hueRange": { "properties": { "high": { "example": 100, "format": "int64", "type": "integer" }, "low": { "example": 20, "format": "int64", "type": "integer" } }, "type": "object" }, "redRange": { "properties": { "high": { "example": 150, "format": "int64", "type": "integer" }, "low": { "example": 90, "format": "int64", "type": "integer" } }, "type": "object" }, "saturationRange": { "properties": { "high": { "example": 50, "format": "int64", "type": "integer" }, "low": { "example": 10, "format": "int64", "type": "integer" } }, "type": "object" }, "score": { "example": 50, "format": "int64", "type": "integer" }, "threshold": { "example": 50, "format": "int64", "type": "integer" }, "valueRange": { "properties": { "high": { "example": 50, "format": "int64", "type": "integer" }, "low": { "example": 10, "format": "int64", "type": "integer" } }, "type": "object" } }, "type": "object" }, "result": { "example": "PASS", "type": "string" }, "textMatch": { "properties": { "foundText": { "example": "ABCD", "type": "string" }, "matchString": { "example": "ABCD", "type": "string" } }, "type": "object" } }, "type": "object" }, "type": "array" }, "Vehicle": { "description": "The vehicle object.", "properties": { "attributes": { "description": "A minified attribute", "items": { "$ref": "#/components/schemas/attributeTiny" }, "type": "array" }, "auxInputType1": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType10": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType11": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType12": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType13": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType2": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType3": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType4": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType5": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType6": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType7": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType8": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "auxInputType9": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "cameraSerial": { "$ref": "#/components/schemas/CameraSerial" }, "esn": { "$ref": "#/components/schemas/VehicleEsn" }, "externalIds": { "$ref": "#/components/schemas/VehicleExternalIds" }, "gateway": { "$ref": "#/components/schemas/gatewayTiny" }, "grossVehicleWeight": { "$ref": "#/components/schemas/GrossVehicleWeight" }, "harshAccelerationSettingType": { "$ref": "#/components/schemas/VehicleHarshAccelerationSettingType" }, "id": { "$ref": "#/components/schemas/VehicleId" }, "licensePlate": { "$ref": "#/components/schemas/VehicleLicensePlate" }, "make": { "$ref": "#/components/schemas/VehicleMake" }, "model": { "$ref": "#/components/schemas/VehicleModel" }, "name": { "$ref": "#/components/schemas/VehicleName" }, "notes": { "$ref": "#/components/schemas/VehicleNotes" }, "sensorConfiguration": { "$ref": "#/components/schemas/VehicleSensorConfiguration" }, "serial": { "$ref": "#/components/schemas/Serial" }, "staticAssignedDriver": { "$ref": "#/components/schemas/driverTinyResponse" }, "tags": { "$ref": "#/components/schemas/VehicleTags" }, "vehicleRegulationMode": { "$ref": "#/components/schemas/VehicleRegulationMode" }, "vehicleType": { "$ref": "#/components/schemas/VehicleType" }, "vin": { "$ref": "#/components/schemas/VehicleVin" }, "year": { "$ref": "#/components/schemas/VehicleYear" } }, "required": [ "id" ], "type": "object" }, "VehicleAssignmentObjectResponseBody": { "properties": { "assignmentType": { "description": "Assignment type of the driver-vehicle assignment, indicating the provenance of the assignment. The only type of assignment supported right now is `driverApp` assignments. This list could change, so it is recommended that clients gracefully handle any types not enumerated in this list. Valid values: `driverApp`", "enum": [ "driverApp" ], "example": "driverApp", "type": "string" }, "endTime": { "description": " An end time in RFC 3339 format. Omitted if not applicable. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "isPassenger": { "description": "Boolean indicating whether the driver is a passenger.", "example": false, "type": "boolean" }, "startTime": { "description": " A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "example": "2019-06-13T19:08:25Z", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/GoaVehicleTinyResponseResponseBody" } }, "required": [ "assignmentType", "isPassenger", "startTime", "vehicle" ], "type": "object" }, "VehicleAuxInputName": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.", "example": "Boom", "type": "string" }, "VehicleAuxInputType": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.", "example": "boom", "type": "string" }, "VehicleAuxInputType1": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType10": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType11": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType12": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType13": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType2": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType3": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType4": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType5": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType6": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType7": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType8": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleAuxInputType9": { "$ref": "#/components/schemas/VehicleAuxInputType" }, "VehicleBatterVoltageDetailsObjectRequestBody": { "description": "Details specific to Vehicle Battery Voltage", "properties": { "batteryVolts": { "description": "The battery volt threshold value.", "example": 100, "format": "int64", "type": "integer" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `GREATER`, `LESS`", "enum": [ "GREATER", "LESS" ], "example": "GREATER", "type": "string" } }, "required": [ "batteryVolts", "minDurationMilliseconds", "operation" ], "type": "object" }, "VehicleBatterVoltageDetailsObjectResponseBody": { "description": "Details specific to Vehicle Battery Voltage", "properties": { "batteryVolts": { "description": "The battery volt threshold value.", "example": 100, "format": "int64", "type": "integer" }, "minDurationMilliseconds": { "description": "The number of milliseconds the trigger needs to stay active before alerting.", "example": 600000, "format": "int64", "type": "integer" }, "operation": { "description": "How to evaluate the threshold. Valid values: `GREATER`, `LESS`", "enum": [ "GREATER", "LESS" ], "example": "GREATER", "type": "string" } }, "required": [ "batteryVolts", "minDurationMilliseconds", "operation" ], "type": "object" }, "VehicleBatteryVoltageResponseBody": { "description": "Details specific to Vehicle Battery Voltage.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "VehicleDefLevelPercentageResponseBody": { "description": "Details specific to Vehicle DEF Level Percentage.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "VehicleDetectedResponseBody": { "description": "Details specific to Vehicle Detected.", "properties": { "cameraStream": { "$ref": "#/components/schemas/alertObjectOnvifCameraStreamResponseBody" } }, "type": "object" }, "VehicleDvirObjectResponseBody": { "description": "A vehicle object", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the vehicle", "example": "494123", "type": "string" } }, "type": "object" }, "VehicleEngineHours": { "description": "A manual override for the vehicle's engine hours. You may only override a vehicle's engine hours if it cannot be read from on-board diagnostics. When you provide a manual engine hours override, Samsara will begin updating a vehicle's engine hours based on when the Samsara Vehicle Gateway is recieving power or not.", "example": 10943, "format": "int64", "type": "integer" }, "VehicleEsn": { "description": "Engine serial number.", "example": "11223344", "type": "string" }, "VehicleExternalIds": { "description": "The \u003Ca href=\"/docs/external-ids\" target=\"_blank\"\u003Eexternal IDs\u003C/a\u003E for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "VehicleFaultCodeDetailsObjectRequestBody": { "description": "Details specific to Vehicle Fault Code. At least one fault code or fault code group must be selected.", "properties": { "hasAnyAmberWarningLampCodes": { "description": "If true then alert on codes for less serious errors that do not warrant stopping. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyFaultCodes": { "description": "If true this means that any code is alertable. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyMalfunctionIndicatorLampCodes": { "description": "If true then alert on emission-related codes. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyProtectionLampCodes": { "description": "If true then alert on codes for non-electric vehicle parts. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyRedStopLampCodes": { "description": "If true then alert when the vehicle warrants stopping. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyTrailerAbsLampCodes": { "description": "If true then alert when the ABS light is on. Defaults to false.", "example": true, "type": "boolean" }, "specificFaultCodes": { "description": "The list of specific fault codes to be alerted on.", "items": { "$ref": "#/components/schemas/SpecificVehicleFaultCodeObjectRequestBody" }, "type": "array" } }, "type": "object" }, "VehicleFaultCodeDetailsObjectResponseBody": { "description": "Details specific to Vehicle Fault Code. At least one fault code or fault code group must be selected.", "properties": { "hasAnyAmberWarningLampCodes": { "description": "If true then alert on codes for less serious errors that do not warrant stopping. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyFaultCodes": { "description": "If true this means that any code is alertable. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyMalfunctionIndicatorLampCodes": { "description": "If true then alert on emission-related codes. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyProtectionLampCodes": { "description": "If true then alert on codes for non-electric vehicle parts. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyRedStopLampCodes": { "description": "If true then alert when the vehicle warrants stopping. Defaults to false.", "example": true, "type": "boolean" }, "hasAnyTrailerAbsLampCodes": { "description": "If true then alert when the ABS light is on. Defaults to false.", "example": true, "type": "boolean" }, "specificFaultCodes": { "description": "The list of specific fault codes to be alerted on.", "items": { "$ref": "#/components/schemas/SpecificVehicleFaultCodeObjectResponseBody" }, "type": "array" } }, "type": "object" }, "VehicleFaultsResponseBody": { "description": "Details specific to Vehicle Faults.", "properties": { "driver": { "$ref": "#/components/schemas/alertObjectDriverResponseBody" }, "trailer": { "$ref": "#/components/schemas/alertObjectTrailerResponseBody" }, "vehicle": { "$ref": "#/components/schemas/alertObjectVehicleResponseBody" } }, "type": "object" }, "VehicleHarshAccelerationSettingType": { "description": "The harsh acceleration setting type. This setting influences the acceleration sensitivity from which a \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043051792-Safety-Event-Overview\" target=\"_blank\"\u003Eharsh event\u003C/a\u003E is triggered. **By default**, this setting is inferred by the Samsara Vehicle Gateway from the engine computer, but it may be set or updated through the Samsara Dashboard or the API at any time. If set to `off`, then no acceleration based harsh events are triggered for the vehicle. Valid values: `passengerCar`, `lightTruck`, `heavyDuty`, `off`, `automatic`.", "enum": [ "passengerCar", "lightTruck", "heavyDuty", "off", "automatic" ], "example": "off", "type": "string" }, "VehicleId": { "description": "The unique Samsara ID of the Vehicle. This is automatically generated when the Vehicle object is created. It cannot be changed.", "example": "112", "type": "string" }, "VehicleLicensePlate": { "description": "The license plate of the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "XHK1234", "maxLength": 12, "type": "string" }, "VehicleLocation": { "description": "Vehicle location event.", "properties": { "heading": { "$ref": "#/components/schemas/VehicleLocationHeading" }, "latitude": { "$ref": "#/components/schemas/VehicleLocationLatitude" }, "longitude": { "$ref": "#/components/schemas/VehicleLocationLongitude" }, "reverseGeo": { "$ref": "#/components/schemas/reverseGeo" }, "speed": { "$ref": "#/components/schemas/VehicleLocationSpeed" }, "time": { "$ref": "#/components/schemas/time" } }, "required": [ "latitude", "longitude", "time" ], "type": "object" }, "VehicleLocationAddress": { "description": "Address that the location is in.", "properties": { "id": { "description": "Id of the address.", "example": "1234", "type": "string" }, "name": { "description": "Name of address.", "example": "Address 1", "type": "string" } }, "type": "object" }, "VehicleLocationHeading": { "description": "Heading of the vehicle in degrees.", "example": 120, "format": "double", "type": "number" }, "VehicleLocationIsEcuSpeed": { "description": "True if the speed value is reported from the ECU. Speed value is reported from GPS otherwise.", "example": true, "type": "boolean" }, "VehicleLocationLatitude": { "description": "GPS latitude represented in degrees", "example": 122.142, "format": "double", "type": "number" }, "VehicleLocationLongitude": { "description": "GPS longitude represented in degrees", "example": -93.343, "format": "double", "type": "number" }, "VehicleLocationReverseGeo": { "$ref": "#/components/schemas/reverseGeo" }, "VehicleLocationSpeed": { "description": "GPS speed of the vehicle in miles per hour. See `isEcuSpeed` to determine speed data source.", "example": 48.3, "format": "double", "type": "number" }, "VehicleLocationTime": { "$ref": "#/components/schemas/time" }, "VehicleLocationsListResponse": { "description": "List of vehicle location events and pagination info.", "properties": { "data": { "description": "A list of vehicles and an array of location events for each vehicle.", "items": { "$ref": "#/components/schemas/VehicleLocationsListResponse_data" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "VehicleLocationsListResponse_data": { "description": "A vehicle and its list of location events.", "properties": { "id": { "$ref": "#/components/schemas/VehicleId" }, "locations": { "description": "A list of location events for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleLocation" }, "type": "array" }, "name": { "$ref": "#/components/schemas/VehicleName" } }, "required": [ "id", "locations", "name" ], "type": "object" }, "VehicleLocationsResponse": { "description": "Most recent vehicle locations and pagination info.", "properties": { "data": { "description": "List of the most recent locations for the specified vehicles.", "items": { "$ref": "#/components/schemas/VehicleLocationsResponse_data" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "VehicleLocationsResponse_data": { "description": "A vehicle and its most recent location.", "properties": { "id": { "$ref": "#/components/schemas/VehicleId" }, "location": { "$ref": "#/components/schemas/VehicleLocation" }, "name": { "$ref": "#/components/schemas/VehicleName" } }, "required": [ "id", "location", "name" ], "type": "object" }, "VehicleMake": { "description": "The Vehicle’s manufacturing make. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set.", "example": "Ford", "maxLength": 255, "type": "string" }, "VehicleModel": { "description": "The Vehicle’s manufacturing model. Automatically read from the engine computer if available. Empty if not available. Cannot be manually set.", "example": "F150", "maxLength": 255, "type": "string" }, "VehicleName": { "description": "The human-readable name of the Vehicle. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. **By default**, this name is the serial number of the Samsara Vehicle Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Truck A7", "type": "string" }, "VehicleNotes": { "description": "These are generic notes about the Vehicle. Empty by default. Can be set or updated through the Samsara Dashboard or the API at any time.", "example": "These are notes about this given vehicle.", "maxLength": 255, "type": "string" }, "VehicleOdometerMeters": { "description": "A manual override for the vehicle's odometer. You may only override a vehicle's odometer if it cannot be read from on-board diagnostics. When you provide a manual odometer override, Samsara will begin updating a vehicle's odometer using GPS distance traveled since this override was set. See \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/115005273667\" target=\"_blank\"\u003Ehere\u003C/a\u003E for more details.", "example": 9182, "format": "int64", "type": "integer" }, "VehicleRegulationMode": { "description": "Whether or not the vehicle is regulated, unregulated (non-CMV), or a mixed use unregulated vehicle. Valid values: `regulated`, `unregulated`, `mixed`.", "enum": [ "regulated", "unregulated", "mixed" ], "example": "regulated", "type": "string" }, "VehicleResponse": { "description": "A single vehicle.", "properties": { "data": { "$ref": "#/components/schemas/Vehicle" } }, "required": [ "data" ], "type": "object" }, "VehicleResponseObjectResponseBody": { "description": "A single vehicle", "properties": { "attributes": { "description": "List of attributes associated with the entity", "items": { "$ref": "#/components/schemas/GoaAttributeTinyResponseBody" }, "type": "array" }, "auxInputType1": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType10": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType11": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType12": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType13": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType2": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType3": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType4": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType5": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType6": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType7": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType8": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "auxInputType9": { "description": "The type of auxiliary input configured for this Vehicle.", "example": "boom", "type": "string" }, "cameraSerial": { "description": "The serial number of the camera installed in the vehicle", "example": "CNCK-VT8-XA8", "type": "string" }, "createdAtTime": { "description": "Time the vehicle was created in RFC 3339 format.", "example": "2000-07-06T06:25:28Z", "format": "date-time", "type": "string" }, "esn": { "description": "Engine serial number.", "example": "56349811", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "gateway": { "$ref": "#/components/schemas/GoaGatewayTinyResponseResponseBody" }, "harshAccelerationSettingType": { "description": "The harsh acceleration setting type.", "example": "off", "type": "string" }, "id": { "description": "ID of the vehicle", "example": "494123", "type": "string" }, "licensePlate": { "description": "The license plate of the vehicle.", "example": "6SAM123", "type": "string" }, "make": { "description": "The Vehicle’s manufacturing make.", "example": "Ford", "type": "string" }, "model": { "description": "The Vehicle’s manufacturing model.", "example": "F150", "type": "string" }, "name": { "description": "Name of the vehicle", "example": "Fleet Truck #1", "type": "string" }, "notes": { "description": "These are generic notes about the Vehicle.", "example": "These are notes about this given vehicle.", "type": "string" }, "sensorConfiguration": { "$ref": "#/components/schemas/vehicleSensorConfigurationResponseBody" }, "serial": { "description": "The serial number of the gateway installed in the vehicle.", "example": "VG12345", "type": "string" }, "staticAssignedDriver": { "$ref": "#/components/schemas/DriverObjectResponseBody" }, "tags": { "description": "The list of tags associated with the Vehicle.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" }, "updatedAtTime": { "description": "Time the vehicle was updated in RFC 3339 format.", "example": "2013-04-16T08:00:16Z", "format": "date-time", "type": "string" }, "vehicleRegulationMode": { "description": "Whether the vehicle is regulated or unregulated (non-CMV). Valid values: `regulated`, `unregulated`", "enum": [ "regulated", "unregulated" ], "example": "regulated", "type": "string" }, "vehicleType": { "description": "The type of the vehicle. Only returned for customers with commercial speed limits (CSL) enabled. Valid values: `unset`, `passenger`, `truck`, `bus`", "enum": [ "unset", "passenger", "truck", "bus" ], "example": "unset", "type": "string" }, "vehicleWeight": { "description": "The weight of the vehicle in either pounds (lb) or kilograms (kg). Unit of weight is unknown. Only returned for customers with commercial speed limits (CSL) enabled.", "example": 1000, "format": "int64", "type": "integer" }, "vehicleWeightInKilograms": { "description": "The weight of the vehicle in kilograms (kg). Only returned for customers with commercial speed limits (CSL) enabled.", "example": 1000, "format": "int64", "type": "integer" }, "vehicleWeightInPounds": { "description": "The weight of the vehicle in pounds (lb). Only returned for customers with commercial speed limits (CSL) enabled.", "example": 2200, "format": "int64", "type": "integer" }, "vin": { "description": "The VIN of the vehicle.", "example": "1GBJ6P1B2HV112765", "type": "string" }, "year": { "example": "2008", "type": "string" } }, "required": [ "createdAtTime", "id" ], "type": "object" }, "VehicleResponseResponseBody": { "description": "A vehicle object", "properties": { "assetType": { "description": "The type of the asset. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "vehicle", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the vehicle", "example": "494123", "type": "string" }, "licensePlate": { "description": "The license plate of the vehicle.", "example": "6SAM123", "type": "string" }, "name": { "description": "Name of the vehicle", "example": "Fleet Truck #1", "type": "string" }, "vehicleVin": { "description": "The VIN of the vehicle.", "example": "1GBJ6P1B2HV112765", "type": "string" } }, "type": "object" }, "VehicleSensorConfiguration": { "description": "The sensors configured on a vehicle", "properties": { "areas": { "items": { "$ref": "#/components/schemas/VehicleSensorConfigurationArea" }, "type": "array" }, "doors": { "items": { "$ref": "#/components/schemas/VehicleSensorConfigurationDoor" }, "type": "array" } }, "type": "object" }, "VehicleSensorConfigurationArea": { "description": "The sensor configuration for an area of the vehicle", "properties": { "cargoSensors": { "description": "Cargo sensors configured in this position of the vehicle", "items": { "$ref": "#/components/schemas/Sensor" }, "type": "array" }, "humiditySensors": { "description": "Humidity sensors configured in this position of the vehicle", "items": { "$ref": "#/components/schemas/Sensor" }, "type": "array" }, "position": { "description": "Position of the area on vehicle", "enum": [ "Position_Front", "Position_Middle", "Position_Back" ], "example": "", "type": "string" }, "temperatureSensors": { "description": "Temperature sensors configured in this position of the vehicle", "items": { "$ref": "#/components/schemas/Sensor" }, "type": "array" } }, "type": "object" }, "VehicleSensorConfigurationDoor": { "description": "A door monitor configuration for a vehicle", "properties": { "position": { "description": "Position of the door monitor on the vehicle", "enum": [ "Position_Left", "Position_Right" ], "example": "", "type": "string" }, "sensor": { "$ref": "#/components/schemas/Sensor" } }, "type": "object" }, "VehicleStaticAssignedDriver": { "$ref": "#/components/schemas/driverTinyResponse" }, "VehicleStaticAssignedDriverId": { "description": "ID for the static assigned driver of the vehicle.", "example": "123", "type": "string" }, "VehicleStatsAmbientAirTempMilliC": { "description": "Vehicle ambient air temperature reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The ambient air temperature reading in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsAmbientAirTempMilliCValue": { "description": "The ambient air temperature reading in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" }, "VehicleStatsAmbientAirTempMilliCWithDecoration": { "description": "Vehicle ambient air temperature reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The ambient air temperature reading in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsAuxInput": { "description": "Data for auxiliary digio equipment.", "properties": { "name": { "$ref": "#/components/schemas/VehicleAuxInputName" }, "time": { "$ref": "#/components/schemas/vehicleStatsAuxInputTime" }, "value": { "description": "Boolean indicating the state of the auxiliary equipment.", "example": true, "type": "boolean" } }, "type": "object" }, "VehicleStatsAuxInputDecoration": { "properties": { "name": { "description": "The type of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary input\u003C/a\u003E configured for this Vehicle. Once configured, these inputs will generate dynamic, time-series data that will be available to view in the Samsara Dashboard. **By default**: empty. This can be set or updated through the Samsara Dashboard or the API at any time. Inputs 3-13 are only available on gateways with an attached aux expander. The value returned will match what is configured in the dashboard per vehicle.", "example": "Boom", "type": "string" }, "value": { "$ref": "#/components/schemas/VehicleStatsAuxInputValue" } }, "required": [ "name", "value" ], "type": "object" }, "VehicleStatsAuxInputValue": { "description": "Boolean indicating the state of the auxiliary equipment.", "example": true, "type": "boolean" }, "VehicleStatsAuxInputWithDecoration": { "description": "Data for auxiliary digio equipment.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "name": { "$ref": "#/components/schemas/VehicleAuxInputName" }, "time": { "$ref": "#/components/schemas/vehicleStatsAuxInputTime" }, "value": { "description": "Boolean indicating the state of the auxiliary equipment.", "example": true, "type": "boolean" } }, "type": "object" }, "VehicleStatsBarometricPressurePa": { "description": "Vehicle barometric pressure reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The barometric pressure reading in pascals.", "example": 99000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsBarometricPressurePaValue": { "description": "The barometric pressure reading in pascals.", "example": 99000, "format": "int64", "type": "integer" }, "VehicleStatsBarometricPressurePaWithDecoration": { "description": "Vehicle barometric pressure reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The barometric pressure reading in pascals.", "example": 100, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsBatteryMilliVoltsValue": { "description": "The battery voltage in millivolts.", "example": 7991, "format": "int64", "type": "integer" }, "VehicleStatsBatteryVoltage": { "description": "Vehicle battery voltage reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The battery voltage in millivolts.", "example": 7991, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsBatteryVoltageWithDecoration": { "description": "Vehicle battery voltage reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The battery voltage in millivolts.", "example": 7991, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsDecorations": { "description": "Optional decorations to the primary stat event. See [here](doc:decorations) for more details. The example shows the response if you were to submit `decorations=engineStates&obdEngineSeconds` to the query parameter:\n\n```json\n\"decorations\":{\n \"engineStates\": {\n \"value\": \"Off\"\n },\n \"obdEngineSeconds\": {\n \"value\": 9723103\n }\n}\n```", "properties": { "ambientAirTemperatureMilliC": { "$ref": "#/components/schemas/VehicleStatsDecorations_ambientAirTemperatureMilliC" }, "auxInput1": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput10": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput11": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput12": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput13": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput2": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput3": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput4": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput5": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput6": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput7": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput8": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "auxInput9": { "$ref": "#/components/schemas/VehicleStatsAuxInputDecoration" }, "barometricPressurePa": { "$ref": "#/components/schemas/VehicleStatsDecorations_barometricPressurePa" }, "batteryMilliVolts": { "$ref": "#/components/schemas/VehicleStatsDecorations_batteryMilliVolts" }, "defLevelMilliPercent": { "$ref": "#/components/schemas/VehicleStatsDecorations_defLevelMilliPercent" }, "ecuSpeedMph": { "$ref": "#/components/schemas/VehicleStatsDecorations_ecuSpeedMph" }, "engineCoolantTemperatureMilliC": { "$ref": "#/components/schemas/VehicleStatsDecorations_engineCoolantTemperatureMilliC" }, "engineImmobilizer": { "$ref": "#/components/schemas/VehicleStatsEngineImmobilizer" }, "engineLoadPercent": { "$ref": "#/components/schemas/VehicleStatsDecorations_engineLoadPercent" }, "engineOilPressureKPa": { "$ref": "#/components/schemas/VehicleStatsDecorations_engineOilPressureKPa" }, "engineRpm": { "$ref": "#/components/schemas/VehicleStatsDecorations_engineRpm" }, "engineStates": { "$ref": "#/components/schemas/VehicleStatsDecorations_engineStates" }, "evAverageBatteryTemperatureMilliCelsius": { "$ref": "#/components/schemas/VehicleStatsEvAverageBatteryTemperatureMilliCelsius" }, "evBatteryCurrentMilliAmp": { "$ref": "#/components/schemas/VehicleStatsEvBatteryCurrentMilliAmp" }, "evBatteryStateOfHealthMilliPercent": { "$ref": "#/components/schemas/VehicleStatsEvBatteryStateOfHealthMilliPercent" }, "evBatteryVoltageMilliVolt": { "$ref": "#/components/schemas/VehicleStatsEvBatteryVoltageMilliVolt" }, "evChargingCurrentMilliAmp": { "$ref": "#/components/schemas/VehicleStatsEvChargingCurrentMilliAmp" }, "evChargingEnergyMicroWh": { "$ref": "#/components/schemas/VehicleStatsEvChargingEnergyMicroWh" }, "evChargingStatus": { "$ref": "#/components/schemas/VehicleStatsEvChargingStatus" }, "evChargingVoltageMilliVolt": { "$ref": "#/components/schemas/VehicleStatsEvChargingVoltageMilliVolt" }, "evConsumedEnergyMicroWh": { "$ref": "#/components/schemas/VehicleStatsEvConsumedEnergyMicroWh" }, "evDistanceDrivenMeters": { "$ref": "#/components/schemas/VehicleStatsEvDistanceDrivenMeters" }, "evRegeneratedEnergyMicroWh": { "$ref": "#/components/schemas/VehicleStatsEvRegeneratedEnergyMicroWh" }, "evStateOfChargeMilliPercent": { "$ref": "#/components/schemas/VehicleStatsEvStateOfChargeMilliPercent" }, "faultCodes": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue" }, "fuelPercents": { "$ref": "#/components/schemas/VehicleStatsDecorations_fuelPercents" }, "gps": { "$ref": "#/components/schemas/VehicleStatsDecorations_gps" }, "gpsDistanceMeters": { "$ref": "#/components/schemas/VehicleStatsDecorations_gpsDistanceMeters" }, "gpsOdometerMeters": { "$ref": "#/components/schemas/VehicleStatsDecorations_gpsOdometerMeters" }, "intakeManifoldTemperatureMilliC": { "$ref": "#/components/schemas/VehicleStatsDecorations_intakeManifoldTemperatureMilliC" }, "obdEngineSeconds": { "$ref": "#/components/schemas/VehicleStatsDecorations_obdEngineSeconds" }, "obdOdometerMeters": { "$ref": "#/components/schemas/VehicleStatsDecorations_obdOdometerMeters" }, "seatbeltDriver": { "$ref": "#/components/schemas/VehicleStatsSeatbeltDriver" }, "spreaderActive": { "$ref": "#/components/schemas/VehicleStatsSpreaderActive" }, "spreaderAirTemp": { "$ref": "#/components/schemas/VehicleStatsSpreaderAirTemp" }, "spreaderBlastState": { "$ref": "#/components/schemas/VehicleStatsSpreaderBlastState" }, "spreaderGranularName": { "$ref": "#/components/schemas/VehicleStatsSpreaderGranularName" }, "spreaderGranularRate": { "$ref": "#/components/schemas/VehicleStatsSpreaderGranularRate" }, "spreaderLiquidName": { "$ref": "#/components/schemas/VehicleStatsSpreaderLiquidName" }, "spreaderLiquidRate": { "$ref": "#/components/schemas/VehicleStatsSpreaderLiquidRate" }, "spreaderOnState": { "$ref": "#/components/schemas/VehicleStatsSpreaderOnState" }, "spreaderPlowStatus": { "$ref": "#/components/schemas/VehicleStatsSpreaderPlowStatus" }, "spreaderPrewetName": { "$ref": "#/components/schemas/VehicleStatsSpreaderPrewetName" }, "spreaderPrewetRate": { "$ref": "#/components/schemas/VehicleStatsSpreaderPrewetRate" }, "spreaderRoadTemp": { "$ref": "#/components/schemas/VehicleStatsSpreaderRoadTemp" }, "tirePressure": { "$ref": "#/components/schemas/VehicleStatsTirePressures" } }, "type": "object" }, "VehicleStatsDecorations_ambientAirTemperatureMilliC": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsAmbientAirTempMilliCValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_barometricPressurePa": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsBarometricPressurePaValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_batteryMilliVolts": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsBatteryMilliVoltsValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_defLevelMilliPercent": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsDefLevelMilliPercentValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_ecuSpeedMph": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsEcuSpeedMphValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_engineCoolantTemperatureMilliC": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsEngineCoolantTempMilliCValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_engineLoadPercent": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsEngineLoadPercentValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_engineOilPressureKPa": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsEngineOilPressureKPaValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_engineRpm": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsEngineRpmValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_engineStates": { "properties": { "value": { "description": "The state of the engine.", "enum": [ "Off", "On", "Idle" ], "example": "On", "type": "string" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_fuelPercents": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsFuelPercentValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_gps": { "properties": { "address": { "$ref": "#/components/schemas/VehicleLocationAddress" }, "headingDegrees": { "$ref": "#/components/schemas/VehicleLocationHeading" }, "isEcuSpeed": { "$ref": "#/components/schemas/VehicleLocationIsEcuSpeed" }, "latitude": { "$ref": "#/components/schemas/VehicleLocationLatitude" }, "longitude": { "$ref": "#/components/schemas/VehicleLocationLongitude" }, "reverseGeo": { "$ref": "#/components/schemas/reverseGeo" }, "speedMilesPerHour": { "$ref": "#/components/schemas/VehicleLocationSpeed" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "VehicleStatsDecorations_gpsDistanceMeters": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsGpsDistanceMetersValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_gpsOdometerMeters": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsGpsOdometerMetersValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_intakeManifoldTemperatureMilliC": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsIntakeManifoldTempMilliCValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_obdEngineSeconds": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsObdEngineSecondsValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDecorations_obdOdometerMeters": { "properties": { "value": { "$ref": "#/components/schemas/VehicleStatsObdOdometerMetersValue" } }, "required": [ "value" ], "type": "object" }, "VehicleStatsDefLevelMilliPercent": { "description": "The Diesel Exhaust Fluid (DEF) milli percentage reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).", "example": 54200, "format": "int64", "maximum": 99999, "minimum": 0, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsDefLevelMilliPercentValue": { "description": "The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).", "example": 54200, "format": "int64", "maximum": 99999, "minimum": 0, "type": "integer" }, "VehicleStatsDefLevelMilliPercentWithDecoration": { "description": "The Diesel Exhaust Fluid (DEF) milli percentage reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).", "example": 54200, "format": "int64", "maximum": 99999, "minimum": 0, "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEcuSpeedMph": { "description": "The speed of the vehicle in miles per hour, as reported by the ECU.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The speed of the vehicle in miles per hour.", "example": 32.1, "format": "double", "type": "number" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEcuSpeedMphValue": { "description": "The speed of the vehicle in miles per hour, as reported by the ECU.", "example": 58.3, "format": "double", "type": "number" }, "VehicleStatsEcuSpeedMphWithDecoration": { "description": "The speed of the vehicle in miles per hour, as reported by the ECU.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The speed of the vehicle in miles per hour.", "example": 32.1, "format": "double", "type": "number" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineCoolantTempMilliC": { "description": "Vehicle engine coolant temperature reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The engine coolant temperature reading in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineCoolantTempMilliCValue": { "description": "The engine coolant temperature reading in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" }, "VehicleStatsEngineCoolantTempMilliCWithDecoration": { "description": "Vehicle engine coolant temperature reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The engine coolant temperature reading in millidegree Celsius.", "example": 31110, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineImmobilizer": { "description": "Data for the engine immobilizer", "properties": { "connected": { "description": "Whether the engine immobilizer is connected or not", "example": false, "type": "boolean" }, "state": { "description": "The state of the engine immobilizer. Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use \u003Ca href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\"\u003EGet engine immobilizer states\u003C/a\u003E to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).", "enum": [ "ignition_disabled", "ignition_enabled" ], "example": "ignition_disabled", "type": "string" }, "time": { "$ref": "#/components/schemas/vehicleStatsAuxInputTime" } }, "required": [ "connected", "state", "time" ], "type": "object" }, "VehicleStatsEngineImmobilizerWithDecoration": { "description": "Data for the engine immobilizer", "properties": { "connected": { "description": "Whether the engine immobilizer is connected or not", "example": false, "type": "boolean" }, "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "state": { "description": "The state of the engine immobilizer. Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use \u003Ca href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\"\u003EGet engine immobilizer states\u003C/a\u003E to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).", "enum": [ "ignition_disabled", "ignition_enabled" ], "example": "ignition_disabled", "type": "string" }, "time": { "$ref": "#/components/schemas/vehicleStatsAuxInputTime" } }, "required": [ "connected", "state", "time" ], "type": "object" }, "VehicleStatsEngineLoadPercent": { "description": "The engine load percentage reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The engine load in percentage points (e.g. `99`, `50`, etc).", "example": 54, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineLoadPercentValue": { "description": "The engine load in percentage points (e.g. `99`, `50`, etc).", "example": 54, "format": "int64", "type": "integer" }, "VehicleStatsEngineLoadPercentWithDecoration": { "description": "The engine load percentage reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The engine load in percentage points (e.g. `99`, `50`, etc).", "example": 54, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineOilPressureKPa": { "description": "Vehicle engine oil pressure reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The engine oil pressure reading in kilopascals.", "example": 100, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineOilPressureKPaValue": { "description": "The engine oil pressure reading in kilopascals.", "example": 100, "format": "int64", "type": "integer" }, "VehicleStatsEngineOilPressureKPaWithDecoration": { "description": "Vehicle engine oil pressure reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The engine oil pressure reading in kilopascals.", "example": 100, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineRpm": { "description": "Vehicle engine RPM reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The revolutions per minute of the engine.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineRpmValue": { "description": "The revolutions per minute of the engine.", "example": 1000, "format": "int64", "type": "integer" }, "VehicleStatsEngineRpmWithDecoration": { "description": "Vehicle engine RPM reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The revolutions per minute of the engine.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineState": { "description": "Vehicle engine state event.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "$ref": "#/components/schemas/VehicleStatsEngineStateSetting" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEngineStateSetting": { "description": "The state of the engine.", "enum": [ "Off", "On", "Idle" ], "example": "On", "type": "string" }, "VehicleStatsEngineStateWithDecoration": { "description": "Vehicle engine state event.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "$ref": "#/components/schemas/VehicleStatsEngineStateSetting" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvAverageBatteryTemperatureMilliCelsius": { "description": "Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Battery temperature for electric and hybrid vehicles in milli celsius.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvAverageBatteryTemperatureMilliCelsiusWithDecoration": { "description": "Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Battery temperature for electric and hybrid vehicles in milli celsius.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvBatteryCurrentMilliAmp": { "description": "Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Battery current for electric and hybrid vehicles in milli amps.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvBatteryCurrentMilliAmpWithDecoration": { "description": "Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Battery current for electric and hybrid vehicles in milli amps.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvBatteryStateOfHealthMilliPercent": { "description": "Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Milli percent battery state of health for electric and hybrid vehicles.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvBatteryStateOfHealthMilliPercentWithDecoration": { "description": "Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Milli percent battery state of health for electric and hybrid vehicles.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvBatteryVoltageMilliVolt": { "description": "Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Battery voltage for electric and hybrid vehicles in milli volts.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvBatteryVoltageMilliVoltWithDecoration": { "description": "Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Battery voltage for electric and hybrid vehicles in milli volts.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvChargingCurrentMilliAmp": { "description": "Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Charging current for electric and hybrid vehicles in milli amps.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvChargingCurrentMilliAmpWithDecoration": { "description": "Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Charging current for electric and hybrid vehicles in milli amps.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvChargingEnergyMicroWh": { "description": "Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Charging energy for electric and hybrid vehicles in microwatt hours.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvChargingEnergyMicroWhWithDecoration": { "description": "Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Charging energy for electric and hybrid vehicles in microwatt hours.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvChargingStatus": { "description": "Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Charging status for electric and hybrid vehicles. Statuses:\n unknown - 0,\n not charging - 1,\n charging - 2.", "enum": [0, 1, 2, 3, 4], "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvChargingStatusWithDecoration": { "description": "Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Charging status for electric and hybrid vehicles. Statuses:\n unknown - 0,\n not charging - 1,\n charging - 2.", "enum": [0, 1, 2, 3, 4], "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvChargingVoltageMilliVolt": { "description": "Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Charging voltage for electric and hybrid vehicles in milli volts.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvChargingVoltageMilliVoltWithDecoration": { "description": "Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Charging voltage for electric and hybrid vehicles in milli volts.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvConsumedEnergyMicroWh": { "description": "Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvConsumedEnergyMicroWhWithDecoration": { "description": "Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvDistanceDrivenMeters": { "description": "Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Electric distance driven for electric and hybrid vehicles in meters.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvDistanceDrivenMetersWithDecoration": { "description": "Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Electric distance driven for electric and hybrid vehicles in meters.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvRegeneratedEnergyMicroWh": { "description": "Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Regenerated energy for electric and hybrid vehicles in microwatt hours.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvRegeneratedEnergyMicroWhWithDecoration": { "description": "Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Regenerated energy for electric and hybrid vehicles in microwatt hours.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvStateOfChargeMilliPercent": { "description": "State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Milli percent State of Charge for electric and hybrid vehicles.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsEvStateOfChargeMilliPercentWithDecoration": { "description": "State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Milli percent State of Charge for electric and hybrid vehicles.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsFaultCodes": { "description": "Engine fault codes read from J1939, OBDII, and OEM vehicles.", "properties": { "canBusType": { "$ref": "#/components/schemas/VehicleStatsFaultCodesCanBusType" }, "j1939": { "$ref": "#/components/schemas/VehicleStatsFaultCodesJ1939" }, "obdii": { "$ref": "#/components/schemas/VehicleStatsFaultCodesOBDII" }, "oem": { "$ref": "#/components/schemas/VehicleStatsFaultCodesOem" }, "time": { "$ref": "#/components/schemas/vehicleStatsAuxInputTime" } }, "required": [ "time" ], "type": "object" }, "VehicleStatsFaultCodesCanBusType": { "description": "The CAN bus type of the vehicle.", "example": "CANBUS_J1939_500", "type": "string" }, "VehicleStatsFaultCodesIgnitionType": { "description": "The ignition type of this passenger vehicle. Valid values: `spark`, `compression`.", "enum": [ "spark", "compression" ], "type": "string" }, "VehicleStatsFaultCodesJ1939": { "description": "Vehicle fault codes for J1939 vehicles.", "properties": { "checkEngineLights": { "$ref": "#/components/schemas/VehicleStatsFaultCodesJ1939Lights" }, "diagnosticTroubleCodes": { "$ref": "#/components/schemas/VehicleStatsFaultCodesJ1939TroubleCodes" } }, "type": "object" }, "VehicleStatsFaultCodesJ1939Lights": { "description": "Status of engine lights on J1939 vehicles.", "properties": { "emissionsIsOn": { "description": "True if the MIL status is nonzero.", "example": true, "type": "boolean" }, "protectIsOn": { "description": "True if the engine protect lamp status is nonzero.", "example": false, "type": "boolean" }, "stopIsOn": { "description": "True if the red lamp status is nonzero.", "example": false, "type": "boolean" }, "warningIsOn": { "description": "True if the amber lamp status is nonzero.", "example": false, "type": "boolean" } }, "required": [ "emissionsIsOn", "protectIsOn", "stopIsOn", "warningIsOn" ], "type": "object" }, "VehicleStatsFaultCodesJ1939TroubleCode": { "description": "Diagnostic trouble code for J1939 vehicles.", "properties": { "fmiDescription": { "description": "A short description of the FMI identifier, if available.", "example": "Voltage Below Normal", "type": "string" }, "fmiId": { "description": "The FMI identifier.", "example": 9, "format": "int32", "type": "integer" }, "milStatus": { "description": "The MIL status, indicating a check engine light.", "example": 1, "format": "int32", "type": "integer" }, "occurrenceCount": { "description": "The number of times this fault has triggered.", "example": 1, "format": "int32", "type": "integer" }, "sourceAddressName": { "description": "The source address name corresponding to the txId", "example": "Engine #1", "type": "string" }, "spnDescription": { "description": "A short description of the SPN identifier, if available.", "example": "System Diagnostic Code #1", "type": "string" }, "spnId": { "description": "The SPN identifier.", "example": 3031, "format": "int32", "type": "integer" }, "txId": { "$ref": "#/components/schemas/VehicleStatsFaultCodesTxId" }, "vendorSpecificFields": { "$ref": "#/components/schemas/VehicleStatsFaultCodesVendorSpecificFields" } }, "required": [ "fmiId", "milStatus", "occurrenceCount", "spnId", "txId" ], "type": "object" }, "VehicleStatsFaultCodesJ1939TroubleCodes": { "description": "Diagnostic trouble codes for J1939 vehicles.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesJ1939TroubleCode" }, "type": "array" }, "VehicleStatsFaultCodesOBDII": { "description": "Vehicle fault codes for passenger vehicles.", "properties": { "checkEngineLightIsOn": { "description": "True if the check engine light is illuminated (MIL status field is nonzero for any faults).", "example": true, "type": "boolean" }, "diagnosticTroubleCodes": { "description": "Diagnostic trouble codes for passenger vehicles.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesOBDIITroubleCode" }, "type": "array" } }, "type": "object" }, "VehicleStatsFaultCodesOBDIITroubleCode": { "description": "Diagnostic trouble code for passenger vehicles.", "properties": { "confirmedDtcs": { "description": "Confirmed DTC codes.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerDtc" }, "type": "array" }, "ignitionType": { "$ref": "#/components/schemas/VehicleStatsFaultCodesIgnitionType" }, "milStatus": { "description": "The MIL status, indicating a check engine light.", "example": true, "type": "boolean" }, "monitorStatus": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatus" }, "pendingDtcs": { "description": "Pending DTC codes.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerDtc" }, "type": "array" }, "permanentDtcs": { "description": "Permanent DTC codes.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerDtc" }, "type": "array" }, "txId": { "$ref": "#/components/schemas/VehicleStatsFaultCodesTxId" } }, "required": [ "txId" ], "type": "object" }, "VehicleStatsFaultCodesOem": { "description": "Vehicle fault codes for OEM vehicles.", "properties": { "diagnosticTroubleCodes": { "$ref": "#/components/schemas/VehicleStatsFaultCodesOemTroubleCodes" } }, "type": "object" }, "VehicleStatsFaultCodesOemTroubleCode": { "description": "Proprietary diagnostic trouble code for some OEM vehicles.", "properties": { "codeDescription": { "description": "The OEM code description.", "example": "KVGT Servo Error", "type": "string" }, "codeIdentifier": { "description": "The OEM code identifier.", "example": "CA2387", "type": "string" }, "codeSeverity": { "description": "The OEM code severity.", "example": "L03", "type": "string" }, "codeSource": { "description": "The OEM code source.", "example": "ENG/M", "type": "string" } }, "type": "object" }, "VehicleStatsFaultCodesOemTroubleCodes": { "description": "Proprietary diagnostic trouble codes for OEM vehicles.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesOemTroubleCode" }, "type": "array" }, "VehicleStatsFaultCodesPassengerDtc": { "description": "Passenger vehicle DTC information", "properties": { "dtcDescription": { "description": "The DTC description, if available.", "example": "Fuel Rail/System Pressure - Too Low Bank 1", "type": "string" }, "dtcId": { "description": "The DTC identifier.", "example": 135, "format": "int32", "type": "integer" }, "dtcShortCode": { "description": "The DTC short code, if available.", "example": "P0087", "type": "string" } }, "required": [ "dtcId" ], "type": "object" }, "VehicleStatsFaultCodesPassengerMonitorStatus": { "description": "Readings from engine sensors", "properties": { "catalyst": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "comprehensive": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "egr": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "evapSystem": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "fuel": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "heatedCatalyst": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "heatedO2Sensor": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "isoSaeReserved": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "misfire": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "notReadyCount": { "description": "Count of the number of sensors reporting N: Not Complete", "type": "integer" }, "o2Sensor": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" }, "secondaryAir": { "$ref": "#/components/schemas/VehicleStatsFaultCodesPassengerMonitorStatusValue" } }, "type": "object" }, "VehicleStatsFaultCodesPassengerMonitorStatusValue": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "VehicleStatsFaultCodesTxId": { "description": "The TX identifier.", "example": 0, "format": "int32", "type": "integer" }, "VehicleStatsFaultCodesValue": { "description": "Fault codes for the vehicle", "properties": { "canBusType": { "description": "The CAN bus type of the vehicle.", "example": "CANBUS_J1939_500", "type": "string" }, "j1939": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_j1939" }, "obdii": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_obdii" }, "oem": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_oem" } }, "type": "object" }, "VehicleStatsFaultCodesValue_j1939": { "description": "Vehicle fault codes for J1939 vehicles.", "properties": { "checkEngineLights": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_j1939_checkEngineLights" }, "diagnosticTroubleCodes": { "description": "Diagnostic trouble codes for J1939 vehicles.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_j1939_diagnosticTroubleCodes" }, "type": "array" } }, "type": "object" }, "VehicleStatsFaultCodesValue_j1939_checkEngineLights": { "description": "Status of engine lights on J1939 vehicles.", "properties": { "emissionsIsOn": { "description": "True if the MIL status is nonzero.", "example": true, "type": "boolean" }, "protectIsOn": { "description": "True if the engine protect lamp status is nonzero.", "example": false, "type": "boolean" }, "stopIsOn": { "description": "True if the red lamp status is nonzero.", "example": false, "type": "boolean" }, "warningIsOn": { "description": "True if the amber lamp status is nonzero.", "example": false, "type": "boolean" } }, "required": [ "emissionsIsOn", "protectIsOn", "stopIsOn", "warningIsOn" ], "type": "object" }, "VehicleStatsFaultCodesValue_j1939_diagnosticTroubleCodes": { "description": "Diagnostic trouble code for J1939 vehicles.", "properties": { "fmiDescription": { "description": "A short description of the FMI identifier, if available.", "example": "Voltage Below Normal", "type": "string" }, "fmiId": { "description": "The FMI identifier.", "example": 9, "format": "int32", "type": "integer" }, "milStatus": { "description": "The MIL status, indicating a check engine light.", "example": 1, "format": "int32", "type": "integer" }, "occurrenceCount": { "description": "The number of times this fault has triggered.", "example": 1, "format": "int32", "type": "integer" }, "sourceAddressName": { "description": "The source address name corresponding to the txId", "example": "Engine #1", "type": "string" }, "spnDescription": { "description": "A short description of the SPN identifier, if available.", "example": "System Diagnostic Code #1", "type": "string" }, "spnId": { "description": "The SPN identifier.", "example": 3031, "format": "int32", "type": "integer" }, "txId": { "description": "The TX identifier.", "example": 0, "format": "int32", "type": "integer" }, "vendorSpecificFields": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_j1939_vendorSpecificFields" } }, "required": [ "fmiId", "milStatus", "occurrenceCount", "spnId", "txId" ], "type": "object" }, "VehicleStatsFaultCodesValue_j1939_vendorSpecificFields": { "description": "Vendor specific data for J1939 vehicles.", "properties": { "dtcDescription": { "description": "The DTC description, if available.", "example": "false", "type": "string" }, "repairInstructionsUrl": { "description": "A link to vendor repair instructions, if available.", "example": "false", "type": "string" } }, "type": "object" }, "VehicleStatsFaultCodesValue_obdii": { "description": "Vehicle fault codes for passenger vehicles.", "properties": { "checkEngineLightIsOn": { "description": "True if the check engine light is illuminated (MIL status field is nonzero for any faults).", "example": true, "type": "boolean" }, "diagnosticTroubleCodes": { "description": "Diagnostic trouble codes for passenger vehicles.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_obdii_diagnosticTroubleCodes" }, "type": "array" } }, "type": "object" }, "VehicleStatsFaultCodesValue_obdii_confirmedDtcs": { "description": "Passenger vehicle DTC information", "properties": { "dtcDescription": { "description": "The DTC description, if available.", "example": "Fuel Rail/System Pressure - Too Low Bank 1", "type": "string" }, "dtcId": { "description": "The DTC identifier.", "example": 135, "format": "int32", "type": "integer" }, "dtcShortCode": { "description": "The DTC short code, if available.", "example": "P0087", "type": "string" } }, "required": [ "dtcId" ], "type": "object" }, "VehicleStatsFaultCodesValue_obdii_diagnosticTroubleCodes": { "description": "Diagnostic trouble code for passenger vehicles.", "properties": { "confirmedDtcs": { "description": "Confirmed DTC codes.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_obdii_confirmedDtcs" }, "type": "array" }, "ignitionType": { "description": "The ignition type of this passenger vehicle. Valid values: `spark`, `compression`.", "enum": [ "spark", "compression" ], "type": "string" }, "milStatus": { "description": "The MIL status, indicating a check engine light.", "example": true, "type": "boolean" }, "monitorStatus": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_obdii_monitorStatus" }, "pendingDtcs": { "description": "Pending DTC codes.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_obdii_confirmedDtcs" }, "type": "array" }, "permanentDtcs": { "description": "Permanent DTC codes.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_obdii_confirmedDtcs" }, "type": "array" }, "txId": { "description": "The TX identifier.", "example": 0, "format": "int32", "type": "integer" } }, "required": [ "txId" ], "type": "object" }, "VehicleStatsFaultCodesValue_obdii_monitorStatus": { "description": "Readings from engine sensors", "properties": { "catalyst": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "comprehensive": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "egr": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "evapSystem": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "fuel": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "heatedCatalyst": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "heatedO2Sensor": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "isoSaeReserved": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "misfire": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "notReadyCount": { "description": "Count of the number of sensors reporting N: Not Complete", "type": "integer" }, "o2Sensor": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" }, "secondaryAir": { "description": "Enum of monitor status:\n-U: Unsupported\n-N: Not Complete\n-R: Complete\n", "enum": [ "N", "R", "U" ], "type": "string" } }, "type": "object" }, "VehicleStatsFaultCodesValue_oem": { "description": "Vehicle fault codes for OEM vehicles.", "properties": { "diagnosticTroubleCodes": { "description": "Proprietary diagnostic trouble codes for OEM vehicles.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesValue_oem_diagnosticTroubleCodes" }, "type": "array" } }, "type": "object" }, "VehicleStatsFaultCodesValue_oem_diagnosticTroubleCodes": { "description": "Proprietary diagnostic trouble code for some OEM vehicles.", "properties": { "codeDescription": { "description": "The OEM code description.", "example": "KVGT Servo Error", "type": "string" }, "codeIdentifier": { "description": "The OEM code identifier.", "example": "CA2387", "type": "string" }, "codeSeverity": { "description": "The OEM code severity.", "example": "L03", "type": "string" }, "codeSource": { "description": "The OEM code source.", "example": "ENG/M", "type": "string" } }, "type": "object" }, "VehicleStatsFaultCodesVendorSpecificFields": { "description": "Vendor specific data for J1939 vehicles.", "properties": { "dtcDescription": { "description": "The DTC description, if available.", "example": "false", "type": "string" }, "repairInstructionsUrl": { "description": "A link to vendor repair instructions, if available.", "example": "false", "type": "string" } }, "type": "object" }, "VehicleStatsFaultCodesWithDecoration": { "description": "Engine fault codes read from J1939, OBDII, and OEM vehicles.", "properties": { "canBusType": { "$ref": "#/components/schemas/VehicleStatsFaultCodesCanBusType" }, "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "j1939": { "$ref": "#/components/schemas/VehicleStatsFaultCodesJ1939" }, "obdii": { "$ref": "#/components/schemas/VehicleStatsFaultCodesOBDII" }, "oem": { "$ref": "#/components/schemas/VehicleStatsFaultCodesOem" }, "time": { "$ref": "#/components/schemas/time" } }, "required": [ "time" ], "type": "object" }, "VehicleStatsFuelPercent": { "description": "Vehicle fuel percentage reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The engine fuel level in percentage points (e.g. `99`, `50`, etc).", "example": 54, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsFuelPercentValue": { "description": "The engine fuel level in percentage points (e.g. `99`, `50`, etc).", "example": 54, "format": "int64", "type": "integer" }, "VehicleStatsFuelPercentWithDecoration": { "description": "Vehicle fuel percentage reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The engine fuel level in percentage points (e.g. `99`, `50`, etc).", "example": 54, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsGps": { "description": "GPS location data for the vehicle.", "properties": { "address": { "$ref": "#/components/schemas/VehicleLocationAddress" }, "headingDegrees": { "$ref": "#/components/schemas/VehicleLocationHeading" }, "isEcuSpeed": { "$ref": "#/components/schemas/VehicleLocationIsEcuSpeed" }, "latitude": { "$ref": "#/components/schemas/VehicleLocationLatitude" }, "longitude": { "$ref": "#/components/schemas/VehicleLocationLongitude" }, "reverseGeo": { "$ref": "#/components/schemas/reverseGeo" }, "speedMilesPerHour": { "$ref": "#/components/schemas/VehicleLocationSpeed" }, "time": { "$ref": "#/components/schemas/time" } }, "required": [ "latitude", "longitude", "time" ], "type": "object" }, "VehicleStatsGpsDistanceMeters": { "description": "Vehicle GPS distance event.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.", "example": 81029.591434899, "format": "double", "type": "number" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsGpsDistanceMetersValue": { "description": "Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.", "example": 81029.591434899, "format": "double", "type": "number" }, "VehicleStatsGpsDistanceMetersWithDecoration": { "description": "Vehicle GPS distance event.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Number of meters the vehicle has traveled since the gateway was installed, based on GPS calculations.", "example": 81029.591434899, "format": "double", "type": "number" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsGpsOdometerMeters": { "description": "Vehicle GPS odometer event.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Number of meters the vehicle has traveled according to the GPS calculations and the manually-specified odometer reading.", "example": 14010293, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsGpsOdometerMetersValue": { "description": "Number of meters the vehicle has traveled according to the GPS calculations and the manually-specified odometer reading.", "example": 14010293, "format": "int64", "type": "integer" }, "VehicleStatsGpsOdometerMetersWithDecoration": { "description": "Vehicle GPS odometer event.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Number of meters the vehicle has traveled according to the GPS calculations and the manually-specified odometer reading.", "example": 14010293, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsIntakeManifoldTempMilliC": { "description": "Vehicle intake manifold temperature reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The intake manifold temperature reading in millidegree Celsius.", "example": 88000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsIntakeManifoldTempMilliCValue": { "description": "The intake manifold temperature reading in millidegree Celsius.", "example": 88000, "format": "int64", "type": "integer" }, "VehicleStatsIntakeManifoldTempMilliCWithDecoration": { "description": "Vehicle intake manifold temperature reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "The intake manifold temperature reading in millidegree Celsius.", "example": 88000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsListGps": { "description": "GPS location data for the vehicle.", "properties": { "address": { "$ref": "#/components/schemas/VehicleLocationAddress" }, "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "headingDegrees": { "$ref": "#/components/schemas/VehicleLocationHeading" }, "isEcuSpeed": { "$ref": "#/components/schemas/VehicleLocationIsEcuSpeed" }, "latitude": { "$ref": "#/components/schemas/VehicleLocationLatitude" }, "longitude": { "$ref": "#/components/schemas/VehicleLocationLongitude" }, "reverseGeo": { "$ref": "#/components/schemas/reverseGeo" }, "speedMilesPerHour": { "$ref": "#/components/schemas/VehicleLocationSpeed" }, "time": { "$ref": "#/components/schemas/time" } }, "required": [ "latitude", "longitude", "time" ], "type": "object" }, "VehicleStatsListResponse": { "description": "List of vehicle stat events and pagination info.", "properties": { "data": { "description": "A list of vehicles and an array of stat events for each vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsListResponse_data" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "VehicleStatsListResponse_data": { "description": "A vehicle and its list of stat events.", "properties": { "ambientAirTemperatureMilliC": { "description": "A list of ambient air temperature readings in millidegree Celsius for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsAmbientAirTempMilliCWithDecoration" }, "type": "array" }, "auxInput1": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput10": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput11": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput12": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput13": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput2": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput3": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput4": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput5": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput6": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput7": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput8": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "auxInput9": { "description": "A list of auxiliary equipment states.", "items": { "$ref": "#/components/schemas/VehicleStatsAuxInputWithDecoration" }, "type": "array" }, "barometricPressurePa": { "description": "A list of barometric pressure readings in pascals for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsBarometricPressurePaWithDecoration" }, "type": "array" }, "batteryMilliVolts": { "description": "A list of battery levels in milliVolts for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsBatteryVoltageWithDecoration" }, "type": "array" }, "defLevelMilliPercent": { "description": "A list of DEF level milli percentage readings for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsDefLevelMilliPercentWithDecoration" }, "type": "array" }, "ecuSpeedMph": { "description": "A list of the speeds of the vehicle in miles per hour, as reported by the ECU.", "items": { "$ref": "#/components/schemas/VehicleStatsEcuSpeedMphWithDecoration" }, "type": "array" }, "engineCoolantTemperatureMilliC": { "description": "A list of engine coolant temperature readings in millidegree Celsius for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsEngineCoolantTempMilliCWithDecoration" }, "type": "array" }, "engineImmobilizer": { "description": "A list of engine immobilizer data for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsEngineImmobilizerWithDecoration" }, "type": "array" }, "engineLoadPercent": { "description": "A list of engine load percentage readings for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsEngineLoadPercentWithDecoration" }, "type": "array" }, "engineOilPressureKPa": { "description": "A list of engine oil pressure readings in kilopascals for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsEngineOilPressureKPaWithDecoration" }, "type": "array" }, "engineRpm": { "description": "A list engine RPM values for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsEngineRpmWithDecoration" }, "type": "array" }, "engineStates": { "description": "A list of engine state events for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsEngineStateWithDecoration" }, "type": "array" }, "evAverageBatteryTemperatureMilliCelsius": { "description": "Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvAverageBatteryTemperatureMilliCelsius" }, "type": "array" }, "evBatteryCurrentMilliAmp": { "description": "Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvBatteryCurrentMilliAmp" }, "type": "array" }, "evBatteryStateOfHealthMilliPercent": { "description": "Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvBatteryStateOfHealthMilliPercent" }, "type": "array" }, "evBatteryVoltageMilliVolt": { "description": "Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvBatteryVoltageMilliVolt" }, "type": "array" }, "evChargingCurrentMilliAmp": { "description": "Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvChargingCurrentMilliAmp" }, "type": "array" }, "evChargingEnergyMicroWh": { "description": "Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvChargingEnergyMicroWh" }, "type": "array" }, "evChargingStatus": { "description": "Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvChargingStatus" }, "type": "array" }, "evChargingVoltageMilliVolt": { "description": "Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvChargingVoltageMilliVolt" }, "type": "array" }, "evConsumedEnergyMicroWh": { "description": "Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvConsumedEnergyMicroWh" }, "type": "array" }, "evDistanceDrivenMeters": { "description": "Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvDistanceDrivenMeters" }, "type": "array" }, "evRegeneratedEnergyMicroWh": { "description": "Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvRegeneratedEnergyMicroWh" }, "type": "array" }, "evStateOfChargeMilliPercent": { "description": "State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "items": { "$ref": "#/components/schemas/VehicleStatsEvStateOfChargeMilliPercent" }, "type": "array" }, "externalIds": { "$ref": "#/components/schemas/VehicleExternalIds" }, "faultCodes": { "description": "A list of engine fault codes.", "items": { "$ref": "#/components/schemas/VehicleStatsFaultCodesWithDecoration" }, "type": "array" }, "fuelPercents": { "description": "A list of fuel percentage readings for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsFuelPercentWithDecoration" }, "type": "array" }, "gps": { "description": "A list of GPS location events for the given vehicles.", "items": { "$ref": "#/components/schemas/VehicleStatsListGps" }, "type": "array" }, "gpsDistanceMeters": { "description": "A list of GPS distance events for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsGpsDistanceMetersWithDecoration" }, "type": "array" }, "gpsOdometerMeters": { "description": "A list of GPS odometer events for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsGpsOdometerMetersWithDecoration" }, "type": "array" }, "id": { "$ref": "#/components/schemas/VehicleId" }, "intakeManifoldTemperatureMilliC": { "description": "A list of intake manifold temperature readings in millidegree Celsius for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsIntakeManifoldTempMilliCWithDecoration" }, "type": "array" }, "name": { "$ref": "#/components/schemas/VehicleName" }, "nfcCardScans": { "description": "A list of NFC cards that were scanned for the given vehicles.", "items": { "$ref": "#/components/schemas/VehicleStatsNfcCardScanWithDecoration" }, "type": "array" }, "obdEngineSeconds": { "description": "A list of OBD engine seconds readings for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsObdEngineSecondsWithDecoration" }, "type": "array" }, "obdOdometerMeters": { "description": "A list of OBD odometer readings for the given vehicle.", "items": { "$ref": "#/components/schemas/VehicleStatsObdOdometerMetersWithDecoration" }, "type": "array" }, "seatbeltDriver": { "description": "Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.", "items": { "$ref": "#/components/schemas/VehicleStatsSeatbeltDriver" }, "type": "array" }, "spreaderActive": { "description": "Whether vehicle is actively spreading any material.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderActive" }, "type": "array" }, "spreaderAirTemp": { "description": "Air (ambient) temperature in milli celsius reading from material spreader.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderAirTemp" }, "type": "array" }, "spreaderBlastState": { "description": "Whether vehicle is actively spreading material in ‘blast mode’.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderBlastState" }, "type": "array" }, "spreaderGranularName": { "description": "Name of most recent type of granular material spread, read from the material spreader.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderGranularName" }, "type": "array" }, "spreaderGranularRate": { "description": "Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderGranularRate" }, "type": "array" }, "spreaderLiquidName": { "description": "Name of most recent type of liquid material spread, read from the material spreader.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderLiquidName" }, "type": "array" }, "spreaderLiquidRate": { "description": "Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderLiquidRate" }, "type": "array" }, "spreaderOnState": { "description": "Whether vehicle spreader is enabled.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderOnState" }, "type": "array" }, "spreaderPlowStatus": { "description": "Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderPlowStatus" }, "type": "array" }, "spreaderPrewetName": { "description": "Name of most recent type of prewet material spread, read from the material spreader.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderPrewetName" }, "type": "array" }, "spreaderPrewetRate": { "description": "Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderPrewetRate" }, "type": "array" }, "spreaderRoadTemp": { "description": "Road temperature reading in milli celsius from material spreader.", "items": { "$ref": "#/components/schemas/VehicleStatsSpreaderRoadTemp" }, "type": "array" }, "syntheticEngineSeconds": { "description": "A list of synthetic engine seconds values.", "items": { "$ref": "#/components/schemas/VehicleStatsListSyntheticEngineSeconds" }, "type": "array" } }, "type": "object" }, "VehicleStatsListSyntheticEngineSeconds": { "description": "A list of synthetic engine seconds for the vehicle.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/vehicleStatsAuxInputTime" }, "value": { "$ref": "#/components/schemas/VehicleStatsSyntheticEngineSecondsValue" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsNfcCardScan": { "description": "Data for the nfc card and the time that it was scanned.", "properties": { "card": { "$ref": "#/components/schemas/VehicleStatsNfcCardScan_card" }, "time": { "$ref": "#/components/schemas/vehicleStatsAuxInputTime" } }, "required": [ "card", "time" ], "type": "object" }, "VehicleStatsNfcCardScanWithDecoration": { "description": "Data for the nfc card and the time that it was scanned.", "properties": { "card": { "$ref": "#/components/schemas/VehicleStatsNfcCardScan_card" }, "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/vehicleStatsAuxInputTime" } }, "required": [ "card", "time" ], "type": "object" }, "VehicleStatsNfcCardScan_card": { "description": "The card that was scanned.", "properties": { "id": { "description": "The id code of the card that was scanned.", "example": "835063", "type": "string" } }, "type": "object" }, "VehicleStatsObdEngineSeconds": { "description": "Vehicle OBD engine seconds reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Number of seconds the vehicle's engine has been on according to the on-board diagnostics.", "example": 9723103, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsObdEngineSecondsValue": { "description": "Number of seconds the vehicle's engine has been on according to the on-board diagnostics.", "example": 9723103, "format": "int64", "type": "integer" }, "VehicleStatsObdEngineSecondsWithDecoration": { "description": "Vehicle OBD engine seconds reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Number of seconds the vehicle's engine has been on according to the on-board diagnostics.", "example": 9723103, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsObdOdometerMeters": { "description": "Vehicle OBD odometer reading.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Number of meters the vehicle has traveled according to the on-board diagnostics.", "example": 14010293, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsObdOdometerMetersValue": { "description": "Number of meters the vehicle has traveled according to the on-board diagnostics.", "example": 14010293, "format": "int64", "type": "integer" }, "VehicleStatsObdOdometerMetersWithDecoration": { "description": "Vehicle OBD odometer reading.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Number of meters the vehicle has traveled according to the on-board diagnostics.", "example": 14010293, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse": { "description": "Vehicle stats snapshot and pagination info.", "properties": { "data": { "description": "List of vehicles and a snapshot of the request stats.", "items": { "$ref": "#/components/schemas/VehicleStatsResponse_data" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/paginationResponse" } }, "required": [ "data", "pagination" ], "type": "object" }, "VehicleStatsResponse_data": { "description": "A vehicle and its most recent stat.", "properties": { "ambientAirTemperatureMilliC": { "$ref": "#/components/schemas/VehicleStatsAmbientAirTempMilliC" }, "auxInput1": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput10": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput11": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput12": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput13": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput2": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput3": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput4": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput5": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput6": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput7": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput8": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "auxInput9": { "$ref": "#/components/schemas/VehicleStatsAuxInput" }, "barometricPressurePa": { "$ref": "#/components/schemas/VehicleStatsBarometricPressurePa" }, "batteryMilliVolts": { "$ref": "#/components/schemas/VehicleStatsBatteryVoltage" }, "defLevelMilliPercent": { "$ref": "#/components/schemas/VehicleStatsDefLevelMilliPercent" }, "ecuSpeedMph": { "$ref": "#/components/schemas/VehicleStatsEcuSpeedMph" }, "engineCoolantTemperatureMilliC": { "$ref": "#/components/schemas/VehicleStatsEngineCoolantTempMilliC" }, "engineImmobilizer": { "$ref": "#/components/schemas/VehicleStatsEngineImmobilizer" }, "engineLoadPercent": { "$ref": "#/components/schemas/VehicleStatsEngineLoadPercent" }, "engineOilPressureKPa": { "$ref": "#/components/schemas/VehicleStatsEngineOilPressureKPa" }, "engineRpm": { "$ref": "#/components/schemas/VehicleStatsEngineRpm" }, "engineState": { "$ref": "#/components/schemas/VehicleStatsEngineState" }, "evAverageBatteryTemperatureMilliCelsius": { "$ref": "#/components/schemas/VehicleStatsResponse_evAverageBatteryTemperatureMilliCelsius" }, "evBatteryCurrentMilliAmp": { "$ref": "#/components/schemas/VehicleStatsResponse_evBatteryCurrentMilliAmp" }, "evBatteryStateOfHealthMilliPercent": { "$ref": "#/components/schemas/VehicleStatsResponse_evBatteryStateOfHealthMilliPercent" }, "evBatteryVoltageMilliVolt": { "$ref": "#/components/schemas/VehicleStatsResponse_evBatteryVoltageMilliVolt" }, "evChargingCurrentMilliAmp": { "$ref": "#/components/schemas/VehicleStatsResponse_evChargingCurrentMilliAmp" }, "evChargingEnergyMicroWh": { "$ref": "#/components/schemas/VehicleStatsResponse_evChargingEnergyMicroWh" }, "evChargingStatus": { "$ref": "#/components/schemas/VehicleStatsResponse_evChargingStatus" }, "evChargingVoltageMilliVolt": { "$ref": "#/components/schemas/VehicleStatsResponse_evChargingVoltageMilliVolt" }, "evConsumedEnergyMicroWh": { "$ref": "#/components/schemas/VehicleStatsResponse_evConsumedEnergyMicroWh" }, "evDistanceDrivenMeters": { "$ref": "#/components/schemas/VehicleStatsResponse_evDistanceDrivenMeters" }, "evRegeneratedEnergyMicroWh": { "$ref": "#/components/schemas/VehicleStatsResponse_evRegeneratedEnergyMicroWh" }, "evStateOfChargeMilliPercent": { "$ref": "#/components/schemas/VehicleStatsResponse_evStateOfChargeMilliPercent" }, "externalIds": { "$ref": "#/components/schemas/VehicleExternalIds" }, "faultCodes": { "$ref": "#/components/schemas/VehicleStatsFaultCodes" }, "fuelPercent": { "$ref": "#/components/schemas/VehicleStatsFuelPercent" }, "gps": { "$ref": "#/components/schemas/VehicleStatsGps" }, "gpsDistanceMeters": { "$ref": "#/components/schemas/VehicleStatsGpsDistanceMeters" }, "gpsOdometerMeters": { "$ref": "#/components/schemas/VehicleStatsGpsOdometerMeters" }, "id": { "$ref": "#/components/schemas/VehicleId" }, "intakeManifoldTemperatureMilliC": { "$ref": "#/components/schemas/VehicleStatsIntakeManifoldTempMilliC" }, "name": { "$ref": "#/components/schemas/VehicleName" }, "nfcCardScan": { "$ref": "#/components/schemas/VehicleStatsNfcCardScan" }, "obdEngineSeconds": { "$ref": "#/components/schemas/VehicleStatsObdEngineSeconds" }, "obdOdometerMeters": { "$ref": "#/components/schemas/VehicleStatsObdOdometerMeters" }, "seatbeltDriver": { "$ref": "#/components/schemas/VehicleStatsResponse_seatbeltDriver" }, "spreaderActive": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderActive" }, "spreaderAirTemp": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderAirTemp" }, "spreaderBlastState": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderBlastState" }, "spreaderGranularName": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderGranularName" }, "spreaderGranularRate": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderGranularRate" }, "spreaderLiquidName": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderLiquidName" }, "spreaderLiquidRate": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderLiquidRate" }, "spreaderOnState": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderOnState" }, "spreaderPlowStatus": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderPlowStatus" }, "spreaderPrewetName": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderPrewetName" }, "spreaderPrewetRate": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderPrewetRate" }, "spreaderRoadTemp": { "$ref": "#/components/schemas/VehicleStatsResponse_spreaderRoadTemp" }, "syntheticEngineSeconds": { "$ref": "#/components/schemas/VehicleStatsSyntheticEngineSeconds" } }, "required": [ "id", "name" ], "type": "object" }, "VehicleStatsResponse_evAverageBatteryTemperatureMilliCelsius": { "description": "Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Battery temperature for electric and hybrid vehicles in milli celsius.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evBatteryCurrentMilliAmp": { "description": "Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Battery current for electric and hybrid vehicles in milli amps.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evBatteryStateOfHealthMilliPercent": { "description": "Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Milli percent battery state of health for electric and hybrid vehicles.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evBatteryVoltageMilliVolt": { "description": "Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Battery voltage for electric and hybrid vehicles in milli volts.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evChargingCurrentMilliAmp": { "description": "Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Charging current for electric and hybrid vehicles in milli amps.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evChargingEnergyMicroWh": { "description": "Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Charging energy for electric and hybrid vehicles in microwatt hours.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evChargingStatus": { "description": "Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Charging status for electric and hybrid vehicles. Statuses:\n unknown - 0,\n not charging - 1,\n charging - 2.", "enum": [0, 1, 2, 3, 4], "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evChargingVoltageMilliVolt": { "description": "Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Charging voltage for electric and hybrid vehicles in milli volts.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evConsumedEnergyMicroWh": { "description": "Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evDistanceDrivenMeters": { "description": "Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Electric distance driven for electric and hybrid vehicles in meters.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evRegeneratedEnergyMicroWh": { "description": "Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Regenerated energy for electric and hybrid vehicles in microwatt hours.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_evStateOfChargeMilliPercent": { "description": "State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Milli percent State of Charge for electric and hybrid vehicles.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_seatbeltDriver": { "description": "Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.", "enum": [ "Buckled", "Unbuckled" ], "example": "Buckled", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderActive": { "description": "Whether vehicle is actively spreading any material.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Whether vehicle is actively spreading any material.", "enum": [ "Off", "On" ], "example": "On", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderAirTemp": { "description": "Air (ambient) temperature in milli celsius reading from material spreader.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Air (ambient) temperature in milli celsius reading from material spreader.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderBlastState": { "description": "Whether vehicle is actively spreading material in ‘blast mode’.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Whether vehicle is actively spreading material in ‘blast mode’.", "enum": [ "On", "Off" ], "example": "Off", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderGranularName": { "description": "Name of most recent type of granular material spread, read from the material spreader.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Name of most recent type of granular material spread, read from the material spreader.", "example": "SALT", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderGranularRate": { "description": "Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderLiquidName": { "description": "Name of most recent type of liquid material spread, read from the material spreader.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Name of most recent type of liquid material spread, read from the material spreader.", "example": "DIR1", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderLiquidRate": { "description": "Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderOnState": { "description": "Whether vehicle spreader is enabled.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Whether vehicle spreader is enabled.", "enum": [ "On", "Off" ], "example": "On", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderPlowStatus": { "description": "Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Snow plow status, as read from the material spreader", "enum": [ "Up", "Down" ], "example": "Down", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderPrewetName": { "description": "Name of most recent type of prewet material spread, read from the material spreader.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Name of most recent type of prewet material spread, read from the material spreader.", "example": "PWT1", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderPrewetRate": { "description": "Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsResponse_spreaderRoadTemp": { "description": "Road temperature reading in milli celsius from material spreader.", "properties": { "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "value": { "description": "Road temperature reading in milli celsius from material spreader.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSeatbeltDriver": { "description": "Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`.", "enum": [ "Buckled", "Unbuckled" ], "example": "Buckled", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderActive": { "description": "Whether vehicle is actively spreading any material.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Whether vehicle is actively spreading any material.", "enum": [ "Off", "On" ], "example": "On", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderAirTemp": { "description": "Air (ambient) temperature in milli celsius reading from material spreader.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Air (ambient) temperature in milli celsius reading from material spreader.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderBlastState": { "description": "Whether vehicle is actively spreading material in ‘blast mode’.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Whether vehicle is actively spreading material in ‘blast mode’.", "enum": [ "On", "Off" ], "example": "Off", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderGranularName": { "description": "Name of most recent type of granular material spread, read from the material spreader.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Name of most recent type of granular material spread, read from the material spreader.", "example": "SALT", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderGranularRate": { "description": "Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderLiquidName": { "description": "Name of most recent type of liquid material spread, read from the material spreader.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Name of most recent type of liquid material spread, read from the material spreader.", "example": "DIR1", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderLiquidRate": { "description": "Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderOnState": { "description": "Whether vehicle spreader is enabled.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Whether vehicle spreader is enabled.", "enum": [ "On", "Off" ], "example": "On", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderPlowStatus": { "description": "Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Snow plow status, as read from the material spreader", "enum": [ "Up", "Down" ], "example": "Down", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderPrewetName": { "description": "Name of most recent type of prewet material spread, read from the material spreader.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Name of most recent type of prewet material spread, read from the material spreader.", "example": "PWT1", "type": "string" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderPrewetRate": { "description": "Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSpreaderRoadTemp": { "description": "Road temperature reading in milli celsius from material spreader.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "description": "Road temperature reading in milli celsius from material spreader.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSyntheticEngineSeconds": { "description": "Data for the synthetic engine seconds for the vehicle", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/vehicleStatsAuxInputTime" }, "value": { "$ref": "#/components/schemas/VehicleStatsSyntheticEngineSecondsValue" } }, "required": [ "time", "value" ], "type": "object" }, "VehicleStatsSyntheticEngineSecondsValue": { "description": "Stats for the number of seconds the vehicle's engine has been on, calculated based on a manually-specified engine seconds reading and the number of seconds the vehicle has been on according to the engine state changes reported to the vehicle gateway since that reading was set. This stat will not be present for any vehicle that does not have the engine seconds reading set. The engine seconds reading can be set from the UI on the vehicle details page.", "example": 14010293, "format": "int64", "type": "integer" }, "VehicleStatsTime": { "$ref": "#/components/schemas/time" }, "VehicleStatsTirePressure": { "description": "Vehicle tire pressure readings.", "properties": { "time": { "$ref": "#/components/schemas/time" }, "value": { "$ref": "#/components/schemas/VehicleStatsTirePressures" } }, "type": "object" }, "VehicleStatsTirePressureWithDecoration": { "description": "Vehicle tire pressure readings.", "properties": { "decorations": { "$ref": "#/components/schemas/VehicleStatsDecorations" }, "time": { "$ref": "#/components/schemas/time" }, "value": { "$ref": "#/components/schemas/VehicleStatsTirePressures" } }, "type": "object" }, "VehicleStatsTirePressures": { "description": "Tire pressure readings for each of four tires in kilopascals.", "properties": { "backLeftTirePressureKPa": { "description": "The tire pressure of the rear left tire as seen when standing behind the vehicle in kilopascals.", "example": 200, "format": "int64", "type": "integer" }, "backRightTirePressureKPa": { "description": "The tire pressure of the rear right tire as seen when standing behind the vehicle in kilopascals.", "example": 200, "format": "int64", "type": "integer" }, "frontLeftTirePressureKPa": { "description": "The tire pressure of the front left tire as seen when standing behind the vehicle in kilopascals.", "example": 200, "format": "int64", "type": "integer" }, "frontRightTirePressureKPa": { "description": "The tire pressure of the front right tire as seen when standing behind the vehicle in kilopascals.", "example": 200, "format": "int64", "type": "integer" } }, "type": "object" }, "VehicleSummary": { "properties": { "anticipationBrakeEventCount": { "$ref": "#/components/schemas/AnticipationBrakeEventCount" }, "coastingDurationMs": { "$ref": "#/components/schemas/CoastingDurationMs" }, "cruiseControlDurationMs": { "$ref": "#/components/schemas/CruiseControlDurationMs" }, "distanceDrivenMeters": { "$ref": "#/components/schemas/DistanceDrivenMeters" }, "driveTimeDurationMs": { "$ref": "#/components/schemas/DriveTimeDurationMs" }, "fuelConsumedMl": { "$ref": "#/components/schemas/FuelConsumedMl" }, "greenBandDrivingDurationMs": { "$ref": "#/components/schemas/GreenBandDrivingDurationMs" }, "highTorqueMs": { "$ref": "#/components/schemas/HighTorqueMs" }, "idleTimeDurationMs": { "$ref": "#/components/schemas/IdleTimeDurationMs" }, "overSpeedMs": { "$ref": "#/components/schemas/OverSpeedMs" }, "powerTakeOffDurationMs": { "$ref": "#/components/schemas/PowerTakeOffDurationMs" }, "totalBrakeEventCount": { "$ref": "#/components/schemas/TotalBrakeEventCount" }, "vehicle": { "$ref": "#/components/schemas/vehicleTinyResponse" } }, "type": "object" }, "VehicleTagIds": { "description": "An array of IDs of tags to associate with this vehicle.", "items": { "example": "321", "type": "string" }, "type": "array" }, "VehicleTags": { "description": "The list of \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043275091-Creating-and-Using-Tags\" target=\"_blank\"\u003Etags\u003C/a\u003E associated with the Vehicle. **By default**: empty. Can be set or updated through the Samsara Dashboard or the API at any time.", "items": { "$ref": "#/components/schemas/tagTinyResponse" }, "type": "array" }, "VehicleType": { "description": "The type of the vehicle. Only returned for customers with commercial speed limits (CSL) enabled.", "example": "truck", "type": "string" }, "VehicleVin": { "description": "The VIN of the Vehicle. Most of the time, this will be automatically read from the engine computer by the Samsara Vehicle Gateway. It will be empty if it cannot be read. It can be set or updated through the Samsara Dashboard or the API at any time.", "example": "1FUJA6BD31LJ09646", "maxLength": 17, "minLength": 11, "type": "string" }, "VehicleWithGatewayTinyResponseResponseBody": { "description": " A minified vehicle object. This object is only returned if the route is assigned to the vehicle.", "properties": { "assetType": { "description": "The type of the asset. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "example": "vehicle", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "gateway": { "$ref": "#/components/schemas/GoaGatewayTinyResponseResponseBody" }, "id": { "description": "ID of the vehicle", "example": "494123", "type": "string" }, "licensePlate": { "description": "The license plate of the vehicle.", "example": "6SAM123", "type": "string" }, "name": { "description": "Name of the vehicle", "example": "Fleet Truck #1", "type": "string" }, "vin": { "description": "The VIN of the vehicle.", "example": "1GBJ6P1B2HV112765", "type": "string" } }, "type": "object" }, "VehicleYear": { "description": "Year of the Vehicle.", "example": "2008", "type": "string" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsResponseBody": { "properties": { "data": { "description": "List of vehicles and their driver assignments.", "items": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesDriverAssignmentsObjectResponseBody": { "properties": { "driverAssignments": { "description": "List of driver assignment objects.", "items": { "$ref": "#/components/schemas/DriverAssignmentObjectResponseBody" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the vehicle.", "example": "494123", "type": "string" }, "name": { "description": "Name of the vehicle.", "example": "Bus-123", "type": "string" } }, "required": [ "driverAssignments", "id" ], "type": "object" }, "VehiclesListVehiclesBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesListVehiclesBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesListVehiclesGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesListVehiclesInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesListVehiclesMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesListVehiclesNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesListVehiclesNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesListVehiclesResponseBody": { "properties": { "data": { "description": "Multiple vehicles.", "items": { "$ref": "#/components/schemas/VehicleResponseObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "VehiclesListVehiclesServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesListVehiclesTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VehiclesListVehiclesUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "VertexRequestBody": { "description": "The vertex of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.", "properties": { "latitude": { "description": "The latitude of a geofence vertex in decimal degrees.", "example": 37.7749, "format": "double", "type": "number" }, "longitude": { "description": "The longitude of a geofence vertex in decimal degrees.", "example": 137.7749, "format": "double", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "VertexResponseBody": { "description": "The vertex of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.", "properties": { "latitude": { "description": "The latitude of a geofence vertex in decimal degrees.", "example": 37.7749, "format": "double", "type": "number" }, "longitude": { "description": "The longitude of a geofence vertex in decimal degrees.", "example": 137.7749, "format": "double", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "VoiceCoachingSettingsObjectResponseBody": { "description": "Enabling voice coaching will play messages for harsh events, speeding, and unbuckled seat belts.", "properties": { "eventsToCoach": { "description": "Selected driving events will be enabled for voice coaching. Harsh driving events include harsh acceleration and harsh brake.", "example": [ "crash", "inCabSpeeding", "maximumSpeed" ], "items": { "description": "Selected driving events will be enabled for voice coaching. Harsh driving events include harsh acceleration and harsh brake. Valid values: `crash`, `inCabSpeeding`, `maximumSpeed`, `seatbeltUnbuckled`, `harshDriving`", "enum": [ "crash", "inCabSpeeding", "maximumSpeed", "seatbeltUnbuckled", "harshDriving" ], "example": "crash", "type": "string" }, "type": "array" }, "isEnabled": { "description": "Indicates whether voice coaching is turned on.", "example": true, "type": "boolean" }, "language": { "description": "The coaching language. The default language is English. Valid values: `english`, `spanish`, `dutch`, `englishUk`, `italian`, `french`, `german`", "enum": [ "english", "spanish", "dutch", "englishUk", "italian", "french", "german" ], "example": "english", "type": "string" }, "speedingThresholdMph": { "description": "Alert when speed is over this many miles per hour.", "example": 10, "format": "double", "type": "number" } }, "type": "object" }, "WalkaroundPhotoObjectResponseBody": { "description": "Walkaround's photo object", "properties": { "createdAtTime": { "description": "Time when walkaround's photo was created in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "name": { "description": "The name of the walkaround's photo", "example": "Name 1", "type": "string" }, "url": { "description": "The URL to the walkaround's photo. Note: the link is available only for 24 hours after it's sent", "example": "https://s3.samsara.com/samsara-driver-media-upload/walkaround-photo-path", "type": "string" } }, "required": [ "createdAtTime", "name", "url" ], "type": "object" }, "WebhookParamsObjectRequestBody": { "description": "The webhook configuration for an Action.", "properties": { "payloadType": { "default": "enriched", "description": "This determines the alert webhook payload type to use. Learn more: https://developers.samsara.com/docs/webhook-reference. Valid values: `legacy`, `enriched`", "enum": [ "legacy", "enriched" ], "example": "enriched", "type": "string" }, "webhookIds": { "description": "The webhook IDs.", "example": [ "123", "123", "123", "123" ], "items": { "description": "The ID of the webhook. This will appear in both Samsara’s cloud dashboard and the API. This is system generated.", "example": "123", "type": "string" }, "type": "array" } }, "required": [ "webhookIds" ], "type": "object" }, "WebhookParamsObjectResponseBody": { "description": "The webhook configuration for an Action.", "properties": { "payloadType": { "default": "enriched", "description": "This determines the alert webhook payload type to use. Learn more: https://developers.samsara.com/docs/webhook-reference. Valid values: `legacy`, `enriched`", "enum": [ "legacy", "enriched" ], "example": "enriched", "type": "string" }, "webhookIds": { "description": "The webhook IDs.", "example": [ "123", "123" ], "items": { "description": "The ID of the webhook. This will appear in both Samsara’s cloud dashboard and the API. This is system generated.", "example": "123", "type": "string" }, "type": "array" } }, "required": [ "webhookIds" ], "type": "object" }, "WebhookResponseResponseBody": { "description": "The response for POST/GET/PATCH a webhook", "properties": { "customHeaders": { "description": "The list of custom headers that users can include with their request", "items": { "$ref": "#/components/schemas/CustomHeadersObjectResponseBody" }, "maxItems": 5, "type": "array" }, "eventTypes": { "description": "The list of event types associated with a particular webhook.", "example": [ "AddressCreated", "AddressCreated", "AddressCreated" ], "items": { "description": "This is the name of the event type. Valid values: `AddressCreated`, `AddressDeleted`, `AddressUpdated`, `AlertIncident`, `AlertObjectEvent`, `DocumentSubmitted`, `DriverCreated`, `DriverUpdated`, `DvirSubmitted`, `EngineFaultOff`, `EngineFaultOn`, `FormSubmitted`, `GatewayUnplugged`, `GeofenceEntry`, `GeofenceExit`, `IssueCreated`, `PredictiveMaintenanceAlert`, `RouteStopArrival`, `RouteStopDeparture`, `RouteStopResequence`, `SevereSpeedingEnded`, `SevereSpeedingStarted`, `SuddenFuelLevelDrop`, `SuddenFuelLevelRise`, `VehicleCreated`, `VehicleUpdated`", "enum": [ "AddressCreated", "AddressDeleted", "AddressUpdated", "AlertIncident", "AlertObjectEvent", "DocumentSubmitted", "DriverCreated", "DriverUpdated", "DvirSubmitted", "EngineFaultOff", "EngineFaultOn", "FormSubmitted", "GatewayUnplugged", "GeofenceEntry", "GeofenceExit", "IssueCreated", "PredictiveMaintenanceAlert", "RouteStopArrival", "RouteStopDeparture", "RouteStopResequence", "SevereSpeedingEnded", "SevereSpeedingStarted", "SuddenFuelLevelDrop", "SuddenFuelLevelRise", "VehicleCreated", "VehicleUpdated" ], "example": "AddressCreated", "type": "string" }, "type": "array" }, "id": { "description": "The ID of the webhook. This will appear in both Samsara’s cloud dashboard and the API. This is the id of the webhook. This is system generated.", "example": "23918", "type": "string" }, "name": { "description": "The name of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Webhook-123", "type": "string" }, "secretKey": { "description": "The secret key of the webhook. This will appear in both Samsara’s cloud dashboard and the API.", "example": "11121-31231-1231212", "type": "string" }, "url": { "description": "The url of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "https://www.webhook-123.com/webhook/listener", "type": "string" }, "version": { "description": "The version of the webhook. Valid values: `2018-01-01`, `2021-06-09`", "enum": [ "2018-01-01", "2021-06-09" ], "example": "2018-01-01", "type": "string" } }, "required": [ "id", "name", "secretKey", "url", "version" ], "type": "object" }, "WebhookRouteResponseObjectResponseBody": { "properties": { "actualRouteEndTime": { "description": "Actual end time, if it exists, for the route in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "actualRouteStartTime": { "description": "Actual start time, if it exists, for the route in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the route", "example": "342341", "type": "string" }, "name": { "description": "Route name", "example": "Bid 123", "type": "string" }, "notes": { "description": "Notes for the route", "example": "These are my notes", "type": "string" }, "scheduledRouteEndTime": { "description": "Scheduled end time, if it exists, for the route in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "scheduledRouteStartTime": { "description": "Scheduled start time, if it exists, for the route in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "settings": { "$ref": "#/components/schemas/RouteSettingsResponseBody" }, "stops": { "description": "List of stops along the route", "items": { "$ref": "#/components/schemas/RoutesStopResponseObjectResponseBody" }, "minItems": 2, "type": "array" } }, "required": [ "id" ], "type": "object" }, "WebhooksDeleteWebhookBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksDeleteWebhookBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksDeleteWebhookGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksDeleteWebhookInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksDeleteWebhookMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksDeleteWebhookNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksDeleteWebhookNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksDeleteWebhookServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksDeleteWebhookTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksDeleteWebhookUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookResponseBody": { "properties": { "customHeaders": { "description": "The list of custom headers that users can include with their request", "items": { "$ref": "#/components/schemas/CustomHeadersObjectResponseBody" }, "maxItems": 5, "type": "array" }, "eventTypes": { "description": "The list of event types associated with a particular webhook.", "example": [ "AddressCreated", "AddressCreated" ], "items": { "description": "This is the name of the event type. Valid values: `AddressCreated`, `AddressDeleted`, `AddressUpdated`, `AlertIncident`, `AlertObjectEvent`, `DocumentSubmitted`, `DriverCreated`, `DriverUpdated`, `DvirSubmitted`, `EngineFaultOff`, `EngineFaultOn`, `FormSubmitted`, `GatewayUnplugged`, `GeofenceEntry`, `GeofenceExit`, `IssueCreated`, `PredictiveMaintenanceAlert`, `RouteStopArrival`, `RouteStopDeparture`, `RouteStopResequence`, `SevereSpeedingEnded`, `SevereSpeedingStarted`, `SuddenFuelLevelDrop`, `SuddenFuelLevelRise`, `VehicleCreated`, `VehicleUpdated`", "enum": [ "AddressCreated", "AddressDeleted", "AddressUpdated", "AlertIncident", "AlertObjectEvent", "DocumentSubmitted", "DriverCreated", "DriverUpdated", "DvirSubmitted", "EngineFaultOff", "EngineFaultOn", "FormSubmitted", "GatewayUnplugged", "GeofenceEntry", "GeofenceExit", "IssueCreated", "PredictiveMaintenanceAlert", "RouteStopArrival", "RouteStopDeparture", "RouteStopResequence", "SevereSpeedingEnded", "SevereSpeedingStarted", "SuddenFuelLevelDrop", "SuddenFuelLevelRise", "VehicleCreated", "VehicleUpdated" ], "example": "AddressCreated", "type": "string" }, "type": "array" }, "id": { "description": "The ID of the webhook. This will appear in both Samsara’s cloud dashboard and the API. This is the id of the webhook. This is system generated.", "example": "23918", "type": "string" }, "name": { "description": "The name of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Webhook-123", "type": "string" }, "secretKey": { "description": "The secret key of the webhook. This will appear in both Samsara’s cloud dashboard and the API.", "example": "11121-31231-1231212", "type": "string" }, "url": { "description": "The url of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "https://www.webhook-123.com/webhook/listener", "type": "string" }, "version": { "description": "The version of the webhook. Valid values: `2018-01-01`, `2021-06-09`", "enum": [ "2018-01-01", "2021-06-09" ], "example": "2018-01-01", "type": "string" } }, "required": [ "id", "name", "secretKey", "url", "version" ], "type": "object" }, "WebhooksGetWebhookServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksGetWebhookUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksResponseBody": { "properties": { "data": { "description": "This is a list of Webhooks.", "items": { "$ref": "#/components/schemas/WebhookResponseResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "WebhooksListWebhooksServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksListWebhooksUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookRequestBody": { "description": "This is the body of the webhook PATCH request.", "properties": { "customHeaders": { "description": "The list of custom headers that users can include with their request", "items": { "$ref": "#/components/schemas/CustomHeadersObjectRequestBody" }, "maxItems": 5, "type": "array" }, "name": { "description": "The name of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Webhook-123", "maxLength": 255, "type": "string" }, "url": { "description": "The url of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "https://www.webhook-123.com/webhook/listener", "maxLength": 2047, "type": "string" }, "version": { "description": "The version of the webhook. Valid values: `2018-01-01`, `2021-06-09`, `2022-09-13`, `2024-02-27`", "enum": [ "2018-01-01", "2021-06-09", "2022-09-13", "2024-02-27" ], "example": "2018-01-01", "type": "string" } }, "type": "object" }, "WebhooksPatchWebhookResponseBody": { "properties": { "customHeaders": { "description": "The list of custom headers that users can include with their request", "items": { "$ref": "#/components/schemas/CustomHeadersObjectResponseBody" }, "maxItems": 5, "type": "array" }, "eventTypes": { "description": "The list of event types associated with a particular webhook.", "example": [ "AddressCreated", "AddressCreated" ], "items": { "description": "This is the name of the event type. Valid values: `AddressCreated`, `AddressDeleted`, `AddressUpdated`, `AlertIncident`, `AlertObjectEvent`, `DocumentSubmitted`, `DriverCreated`, `DriverUpdated`, `DvirSubmitted`, `EngineFaultOff`, `EngineFaultOn`, `FormSubmitted`, `GatewayUnplugged`, `GeofenceEntry`, `GeofenceExit`, `IssueCreated`, `PredictiveMaintenanceAlert`, `RouteStopArrival`, `RouteStopDeparture`, `RouteStopResequence`, `SevereSpeedingEnded`, `SevereSpeedingStarted`, `SuddenFuelLevelDrop`, `SuddenFuelLevelRise`, `VehicleCreated`, `VehicleUpdated`", "enum": [ "AddressCreated", "AddressDeleted", "AddressUpdated", "AlertIncident", "AlertObjectEvent", "DocumentSubmitted", "DriverCreated", "DriverUpdated", "DvirSubmitted", "EngineFaultOff", "EngineFaultOn", "FormSubmitted", "GatewayUnplugged", "GeofenceEntry", "GeofenceExit", "IssueCreated", "PredictiveMaintenanceAlert", "RouteStopArrival", "RouteStopDeparture", "RouteStopResequence", "SevereSpeedingEnded", "SevereSpeedingStarted", "SuddenFuelLevelDrop", "SuddenFuelLevelRise", "VehicleCreated", "VehicleUpdated" ], "example": "AddressCreated", "type": "string" }, "type": "array" }, "id": { "description": "The ID of the webhook. This will appear in both Samsara’s cloud dashboard and the API. This is the id of the webhook. This is system generated.", "example": "23918", "type": "string" }, "name": { "description": "The name of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Webhook-123", "type": "string" }, "secretKey": { "description": "The secret key of the webhook. This will appear in both Samsara’s cloud dashboard and the API.", "example": "11121-31231-1231212", "type": "string" }, "url": { "description": "The url of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "https://www.webhook-123.com/webhook/listener", "type": "string" }, "version": { "description": "The version of the webhook. Valid values: `2018-01-01`, `2021-06-09`", "enum": [ "2018-01-01", "2021-06-09" ], "example": "2018-01-01", "type": "string" } }, "required": [ "id", "name", "secretKey", "url", "version" ], "type": "object" }, "WebhooksPatchWebhookServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPatchWebhookUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksRequestBody": { "description": "This is the body of the webhook POST request.", "properties": { "customHeaders": { "description": "The list of custom headers that users can include with their request", "items": { "$ref": "#/components/schemas/CustomHeadersObjectRequestBody" }, "maxItems": 5, "type": "array" }, "eventTypes": { "description": "[beta] The list of event types associated with a particular event type", "example": [ "DriverCreated", "DriverCreated" ], "items": { "description": "event type name Valid values: `AddressCreated`, `AddressDeleted`, `AddressUpdated`, `AlertIncident`, `AlertObjectEvent`, `DocumentSubmitted`, `DriverCreated`, `DriverUpdated`, `DvirSubmitted`, `EngineFaultOff`, `EngineFaultOn`, `FormSubmitted`, `GatewayUnplugged`, `GeofenceEntry`, `GeofenceExit`, `IssueCreated`, `PredictiveMaintenanceAlert`, `RouteStopArrival`, `RouteStopDeparture`, `RouteStopResequence`, `SevereSpeedingEnded`, `SevereSpeedingStarted`, `SuddenFuelLevelDrop`, `SuddenFuelLevelRise`, `VehicleCreated`, `VehicleUpdated`", "enum": [ "AddressCreated", "AddressDeleted", "AddressUpdated", "AlertIncident", "AlertObjectEvent", "DocumentSubmitted", "DriverCreated", "DriverUpdated", "DvirSubmitted", "EngineFaultOff", "EngineFaultOn", "FormSubmitted", "GatewayUnplugged", "GeofenceEntry", "GeofenceExit", "IssueCreated", "PredictiveMaintenanceAlert", "RouteStopArrival", "RouteStopDeparture", "RouteStopResequence", "SevereSpeedingEnded", "SevereSpeedingStarted", "SuddenFuelLevelDrop", "SuddenFuelLevelRise", "VehicleCreated", "VehicleUpdated" ], "example": "DriverCreated", "type": "string" }, "type": "array" }, "name": { "description": "The name of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Webhook-123", "maxLength": 255, "type": "string" }, "url": { "description": "The url of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "https://www.Webhook-123.com/webhook/listener", "maxLength": 2047, "type": "string" }, "version": { "description": "The version of the webhook. Valid values: `2018-01-01`, `2021-06-09`, `2022-09-13`, `2024-02-27`", "enum": [ "2018-01-01", "2021-06-09", "2022-09-13", "2024-02-27" ], "example": "2018-01-01", "type": "string" } }, "required": [ "name", "url" ], "type": "object" }, "WebhooksPostWebhooksResponseBody": { "properties": { "customHeaders": { "description": "The list of custom headers that users can include with their request", "items": { "$ref": "#/components/schemas/CustomHeadersObjectResponseBody" }, "maxItems": 5, "type": "array" }, "eventTypes": { "description": "The list of event types associated with a particular webhook.", "example": [ "AddressCreated", "AddressCreated", "AddressCreated", "AddressCreated" ], "items": { "description": "This is the name of the event type. Valid values: `AddressCreated`, `AddressDeleted`, `AddressUpdated`, `AlertIncident`, `AlertObjectEvent`, `DocumentSubmitted`, `DriverCreated`, `DriverUpdated`, `DvirSubmitted`, `EngineFaultOff`, `EngineFaultOn`, `FormSubmitted`, `GatewayUnplugged`, `GeofenceEntry`, `GeofenceExit`, `IssueCreated`, `PredictiveMaintenanceAlert`, `RouteStopArrival`, `RouteStopDeparture`, `RouteStopResequence`, `SevereSpeedingEnded`, `SevereSpeedingStarted`, `SuddenFuelLevelDrop`, `SuddenFuelLevelRise`, `VehicleCreated`, `VehicleUpdated`", "enum": [ "AddressCreated", "AddressDeleted", "AddressUpdated", "AlertIncident", "AlertObjectEvent", "DocumentSubmitted", "DriverCreated", "DriverUpdated", "DvirSubmitted", "EngineFaultOff", "EngineFaultOn", "FormSubmitted", "GatewayUnplugged", "GeofenceEntry", "GeofenceExit", "IssueCreated", "PredictiveMaintenanceAlert", "RouteStopArrival", "RouteStopDeparture", "RouteStopResequence", "SevereSpeedingEnded", "SevereSpeedingStarted", "SuddenFuelLevelDrop", "SuddenFuelLevelRise", "VehicleCreated", "VehicleUpdated" ], "example": "AddressCreated", "type": "string" }, "type": "array" }, "id": { "description": "The ID of the webhook. This will appear in both Samsara’s cloud dashboard and the API. This is the id of the webhook. This is system generated.", "example": "23918", "type": "string" }, "name": { "description": "The name of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Webhook-123", "type": "string" }, "secretKey": { "description": "The secret key of the webhook. This will appear in both Samsara’s cloud dashboard and the API.", "example": "11121-31231-1231212", "type": "string" }, "url": { "description": "The url of the webhook. This will appear in both Samsara’s cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "https://www.webhook-123.com/webhook/listener", "type": "string" }, "version": { "description": "The version of the webhook. Valid values: `2018-01-01`, `2021-06-09`", "enum": [ "2018-01-01", "2021-06-09" ], "example": "2018-01-01", "type": "string" } }, "required": [ "id", "name", "secretKey", "url", "version" ], "type": "object" }, "WebhooksPostWebhooksServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WebhooksPostWebhooksUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrderAttachmentObjectResponseBody": { "description": "Work Order Attachment object.", "properties": { "id": { "description": "ID of the media record.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "processingStatus": { "description": "Status of the media record. Valid values: `unknown`, `processing`, `finished`", "enum": [ "unknown", "processing", "finished" ], "example": "processing", "type": "string" }, "url": { "description": "URL containing a link to associated media content. Included if 'processingStatus' is 'finished'.", "example": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456", "format": "uri", "type": "string" }, "urlExpiresAt": { "description": "Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "id", "processingStatus" ], "type": "object" }, "WorkOrderDiscountObjectRequestBody": { "description": "How much a work order is discounted. Either money or basisPoints are specified.", "properties": { "basisPoints": { "description": "The discount in basis points. 100 basis points = 1%.", "example": 500, "format": "int64", "type": "integer" }, "money": { "$ref": "#/components/schemas/WorkOrderMoneyObjectRequestBody" } }, "type": "object" }, "WorkOrderDiscountObjectResponseBody": { "description": "How much a work order is discounted. Either money or basisPoints are specified.", "properties": { "basisPoints": { "description": "The discount in basis points. 100 basis points = 1%.", "example": 500, "format": "int64", "type": "integer" }, "money": { "$ref": "#/components/schemas/WorkOrderMoneyObjectResponseBody" } }, "type": "object" }, "WorkOrderItemObjectRequestBody": { "description": "Work Order Related Item object.", "properties": { "id": { "description": "ID of the item.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "type": { "description": "The type of item. Valid values: `DVIR`, `FAULT`, `FORM`, `ISSUE`, `ITEM_TYPE_UNSPECIFIED`, `SCHEDULED_MAINTENANCE`", "enum": [ "DVIR", "FAULT", "FORM", "ISSUE", "ITEM_TYPE_UNSPECIFIED", "SCHEDULED_MAINTENANCE" ], "example": "ISSUE", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "WorkOrderItemObjectResponseBody": { "description": "Work Order Related Item object.", "properties": { "id": { "description": "ID of the item.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "type": { "description": "The type of item. Valid values: `DVIR`, `FAULT`, `FORM`, `ISSUE`, `ITEM_TYPE_UNSPECIFIED`, `SCHEDULED_MAINTENANCE`", "enum": [ "DVIR", "FAULT", "FORM", "ISSUE", "ITEM_TYPE_UNSPECIFIED", "SCHEDULED_MAINTENANCE" ], "example": "ISSUE", "type": "string" } }, "required": [ "id", "type" ], "type": "object" }, "WorkOrderMoneyObjectRequestBody": { "description": "A specified amount of money.", "properties": { "amount": { "description": "Amount of the currency.", "example": "94.01", "type": "string" }, "currency": { "description": "Type of the currency. We currently only support usd. Valid values: `usd`", "enum": [ "usd" ], "example": "usd", "type": "string" } }, "required": [ "amount", "currency" ], "type": "object" }, "WorkOrderMoneyObjectResponseBody": { "description": "A specified amount of money.", "properties": { "amount": { "description": "Amount of the currency.", "example": "94.01", "type": "string" }, "currency": { "description": "Type of the currency. We currently only support usd. Valid values: `usd`", "enum": [ "usd" ], "example": "usd", "type": "string" } }, "required": [ "amount", "currency" ], "type": "object" }, "WorkOrderObjectResponseBody": { "description": "A work order object.", "properties": { "archivedAtTime": { "description": "The time the work order was archived in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "assetId": { "description": "The ID of the asset.", "example": "12443", "type": "string" }, "assignedUserId": { "description": "The ID of the assigned mechanic.", "example": "1234", "type": "string" }, "attachments": { "description": "Files attached to the work order.", "items": { "$ref": "#/components/schemas/WorkOrderAttachmentObjectResponseBody" }, "type": "array" }, "category": { "description": "The category of the work order Valid values: `ANNUAL`, `CORRECTIVE`, `DAMAGE_REPAIR`, `PREVENTIVE`, `RECALL`, `UNSPECIFIED`", "enum": [ "ANNUAL", "CORRECTIVE", "DAMAGE_REPAIR", "PREVENTIVE", "RECALL", "UNSPECIFIED" ], "example": "PREVENTIVE", "type": "string" }, "closingNotes": { "description": "Notes on the work order.", "example": "Everything was fixed without issues.", "type": "string" }, "completedAtTime": { "description": "The time the work order was completed in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "createdAtTime": { "description": "The time the work order was created in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "createdByUserId": { "description": "The ID of the creator of the work order.", "example": "1234", "type": "string" }, "description": { "description": "A description of what needs to be fixed.", "example": "The vehicle is not starting.", "type": "string" }, "discount": { "$ref": "#/components/schemas/WorkOrderDiscountObjectResponseBody" }, "dueAtTime": { "description": "The due date of the work order in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "engineHours": { "description": "The engine hours at the time of the work order.", "example": 91823, "format": "int64", "type": "integer" }, "id": { "description": "The unique id of the work order.", "example": "5", "type": "string" }, "items": { "description": "Items related to the work order.", "items": { "$ref": "#/components/schemas/WorkOrderItemObjectResponseBody" }, "type": "array" }, "odometerMeters": { "description": "The odometer reading at the time of the work order.", "example": 91823, "format": "int64", "type": "integer" }, "priority": { "description": "The priority of the work order Valid values: `HIGH`, `LOW`, `MEDIUM`, `URGENT`", "enum": [ "HIGH", "LOW", "MEDIUM", "URGENT" ], "example": "HIGH", "type": "string" }, "serviceTaskInstances": { "description": "Service Tasks for the work order.", "items": { "$ref": "#/components/schemas/ServiceTaskInstanceObjectResponseBody" }, "type": "array" }, "status": { "description": "The status of the work order Valid values: `ASSIGNED`, `CANCELLED`, `CLOSED`, `COMPLETED`, `IN_PROGRESS`, `ON_HOLD`, `OPEN`, `PENDING_APPROVAL`, `PENDING_PARTS`", "enum": [ "ASSIGNED", "CANCELLED", "CLOSED", "COMPLETED", "IN_PROGRESS", "ON_HOLD", "OPEN", "PENDING_APPROVAL", "PENDING_PARTS" ], "example": "OPEN", "type": "string" }, "tax": { "$ref": "#/components/schemas/WorkOrderTaxObjectResponseBody" }, "updatedAtTime": { "description": "The time the work order was last updated in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "assetId", "createdAtTime", "id", "status", "updatedAtTime" ], "type": "object" }, "WorkOrderTaxObjectRequestBody": { "description": "How much tax is applied to a work order. Either money or basisPoints are specified.", "properties": { "basisPoints": { "description": "The tax in basis points. 100 basis points = 1%.", "example": 700, "format": "int64", "type": "integer" }, "money": { "$ref": "#/components/schemas/WorkOrderMoneyObjectRequestBody" } }, "type": "object" }, "WorkOrderTaxObjectResponseBody": { "description": "How much tax is applied to a work order. Either money or basisPoints are specified.", "properties": { "basisPoints": { "description": "The tax in basis points. 100 basis points = 1%.", "example": 700, "format": "int64", "type": "integer" }, "money": { "$ref": "#/components/schemas/WorkOrderMoneyObjectResponseBody" } }, "type": "object" }, "WorkOrdersDeleteWorkOrdersBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersDeleteWorkOrdersBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersDeleteWorkOrdersGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersDeleteWorkOrdersInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersDeleteWorkOrdersMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersDeleteWorkOrdersNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersDeleteWorkOrdersNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersDeleteWorkOrdersServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersDeleteWorkOrdersTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersDeleteWorkOrdersUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksResponseBody": { "properties": { "data": { "description": "Service Task Definitions", "items": { "$ref": "#/components/schemas/ServiceTaskDefinitionObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "WorkOrdersGetServiceTasksServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetServiceTasksUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersResponseBody": { "properties": { "data": { "description": "Work Orders", "items": { "$ref": "#/components/schemas/WorkOrderObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersRequestBody": { "description": "Work Order Request.", "properties": { "assignedUserId": { "description": "The ID of the assigned mechanic.", "example": "1234", "type": "string" }, "category": { "description": "The category of the work order Valid values: `ANNUAL`, `CORRECTIVE`, `DAMAGE_REPAIR`, `PREVENTIVE`, `RECALL`, `UNSPECIFIED`", "enum": [ "ANNUAL", "CORRECTIVE", "DAMAGE_REPAIR", "PREVENTIVE", "RECALL", "UNSPECIFIED" ], "example": "PREVENTIVE", "type": "string" }, "closingNotes": { "description": "Notes on the work order.", "example": "Everything was fixed without issues.", "type": "string" }, "completedAtTime": { "description": "The time the work order was completed in RFC 3339 format. Is automatically set when the status changes and this field is not provided.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "description": { "description": "A description of what needs to be fixed.", "example": "The vehicle is not starting.", "type": "string" }, "discount": { "$ref": "#/components/schemas/WorkOrderDiscountObjectRequestBody" }, "dueAtTime": { "description": "The due date of the work order in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "engineHours": { "description": "The engine hours at the time of the work order. Will default to current asset reading if unset.", "example": 91823, "format": "int64", "type": "integer" }, "id": { "description": "The unique id of the work order.", "example": "5", "type": "string" }, "items": { "description": "Items related to the work order.", "items": { "$ref": "#/components/schemas/WorkOrderItemObjectRequestBody" }, "type": "array" }, "odometerMeters": { "description": "The odometer reading at the time of the work order. Will default to current asset reading if unset.", "example": 91823, "format": "int64", "type": "integer" }, "priority": { "description": "The priority of the work order Valid values: `HIGH`, `LOW`, `MEDIUM`, `URGENT`", "enum": [ "HIGH", "LOW", "MEDIUM", "URGENT" ], "example": "HIGH", "type": "string" }, "serviceTaskInstances": { "description": "Service Tasks for the work order.", "items": { "$ref": "#/components/schemas/ServiceTaskInstanceObjectRequestBody" }, "type": "array" }, "status": { "description": "The status of the work order Valid values: `ASSIGNED`, `CANCELLED`, `CLOSED`, `COMPLETED`, `IN_PROGRESS`, `ON_HOLD`, `OPEN`, `PENDING_APPROVAL`, `PENDING_PARTS`", "enum": [ "ASSIGNED", "CANCELLED", "CLOSED", "COMPLETED", "IN_PROGRESS", "ON_HOLD", "OPEN", "PENDING_APPROVAL", "PENDING_PARTS" ], "example": "OPEN", "type": "string" }, "tax": { "$ref": "#/components/schemas/WorkOrderTaxObjectRequestBody" } }, "required": [ "id" ], "type": "object" }, "WorkOrdersPatchWorkOrdersResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/WorkOrderObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "WorkOrdersPatchWorkOrdersServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPatchWorkOrdersUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersRequestBody": { "description": "Work Order Request", "properties": { "assetId": { "description": "The ID of the asset.", "example": "12443", "type": "string" }, "assignedUserId": { "description": "The ID of the assigned mechanic.", "example": "1234", "type": "string" }, "category": { "description": "The category of the work order Valid values: `ANNUAL`, `CORRECTIVE`, `DAMAGE_REPAIR`, `PREVENTIVE`, `RECALL`, `UNSPECIFIED`", "enum": [ "ANNUAL", "CORRECTIVE", "DAMAGE_REPAIR", "PREVENTIVE", "RECALL", "UNSPECIFIED" ], "example": "PREVENTIVE", "type": "string" }, "createdByUserId": { "description": "The ID of the creator of the work order.", "example": "1234", "type": "string" }, "description": { "description": "A description of what needs to be fixed.", "example": "The vehicle is not starting.", "type": "string" }, "discount": { "$ref": "#/components/schemas/WorkOrderDiscountObjectRequestBody" }, "dueAtTime": { "description": "The due date of the work order in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "engineHours": { "description": "The engine hours at the time of the work order. Will default to current asset reading if unset.", "example": 91823, "format": "int64", "type": "integer" }, "items": { "description": "Items related to the work order.", "items": { "$ref": "#/components/schemas/WorkOrderItemObjectRequestBody" }, "type": "array" }, "odometerMeters": { "description": "The odometer reading at the time of the work order. Will default to current asset reading if unset.", "example": 91823, "format": "int64", "type": "integer" }, "priority": { "description": "The priority of the work order Valid values: `HIGH`, `LOW`, `MEDIUM`, `URGENT`", "enum": [ "HIGH", "LOW", "MEDIUM", "URGENT" ], "example": "HIGH", "type": "string" }, "serviceTaskInstances": { "description": "Service Tasks for the work order.", "items": { "$ref": "#/components/schemas/ServiceTaskInstanceObjectRequestBody" }, "type": "array" }, "tax": { "$ref": "#/components/schemas/WorkOrderTaxObjectRequestBody" } }, "required": [ "assetId" ], "type": "object" }, "WorkOrdersPostWorkOrdersResponseBody": { "properties": { "data": { "$ref": "#/components/schemas/WorkOrderObjectResponseBody" } }, "required": [ "data" ], "type": "object" }, "WorkOrdersPostWorkOrdersServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersPostWorkOrdersUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersBadGatewayErrorResponseBody": { "description": "Bad Gateway", "properties": { "message": { "description": "Message of error", "example": "rpc error: code = Unknown desc = connection refused", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersBadRequestErrorResponseBody": { "description": "Bad Request parameters", "properties": { "message": { "description": "Message of error", "example": "Invalid value for parameter.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersGatewayTimeoutErrorResponseBody": { "description": "Gateway timeout", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersInternalServerErrorResponseBody": { "description": "An internal server error occurred", "properties": { "message": { "description": "Message of error", "example": "Failed to execute GraphQL query.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersMethodNotAllowedErrorResponseBody": { "description": "Method not allowed", "properties": { "message": { "description": "Message of error", "example": "DELETE not allowed on /endpoint.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersNotFoundErrorResponseBody": { "description": "Resource not found", "properties": { "message": { "description": "Message of error", "example": "Object not found.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersNotImplementedErrorResponseBody": { "description": "Requested endpoint is not yet implemented", "properties": { "message": { "description": "Message of error", "example": "Not implemented.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersResponseBody": { "properties": { "data": { "description": "Work Orders", "items": { "$ref": "#/components/schemas/WorkOrderObjectResponseBody" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/GoaPaginationResponseResponseBody" } }, "required": [ "data", "pagination" ], "type": "object" }, "WorkOrdersStreamWorkOrdersServiceUnavailableErrorResponseBody": { "description": "Service unavailable", "properties": { "message": { "description": "Message of error", "example": "context deadline exceeded", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersTooManyRequestsErrorResponseBody": { "description": "Too many requests", "properties": { "message": { "description": "Message of error", "example": "Exceeded rate limit.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody": { "description": "Unauthorized", "properties": { "message": { "description": "Message of error", "example": "Invalid token.", "type": "string" }, "requestId": { "description": "The request ID; used when reaching out to support for issues with requests.", "example": "8916e1c1", "type": "string" } }, "required": [ "message", "requestId" ], "type": "object" }, "WorkflowAddressEventWithGeofenceObjectResponseBody": { "description": "A minimal Address object representation used in AddressEventObject objects", "properties": { "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "formattedAddress": { "description": "The full street address for this address/geofence, as it might be recognized by Google Maps.", "example": "350 Rhode Island St, San Francisco, CA", "type": "string" }, "geofence": { "$ref": "#/components/schemas/WorkflowGeofenceResponseBody" }, "id": { "description": "Id of the address", "example": "494123", "type": "string" }, "name": { "description": "Name of the address", "example": "Company Office #1", "type": "string" } }, "required": [ "formattedAddress", "id", "name" ], "type": "object" }, "WorkflowAuthorSignatureObjectResponseBody": { "description": "An author signature for DVIRs with a signed time.", "properties": { "signatoryUser": { "$ref": "#/components/schemas/WorkflowSignatoryUserObjectResponseBody" }, "signedAtTime": { "description": "The time when the DVIR was signed. UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "type": { "description": "Whether the DVIR was submitted by a driver or mechanic. Valid values: `driver`, `mechanic`", "enum": [ "driver", "mechanic" ], "example": "driver", "type": "string" } }, "required": [ "signatoryUser", "signedAtTime", "type" ], "type": "object" }, "WorkflowCircleResponseBody": { "description": "Information about a circular geofence. This field is only needed if the geofence is a circle.", "properties": { "latitude": { "description": "Latitude of the address. Will be geocoded from formattedAddress if not provided.", "example": 37.7749, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of the address. Will be geocoded from formattedAddress if not provided.", "example": 137.7749, "format": "double", "type": "number" }, "radiusMeters": { "description": "The radius of the circular geofence in meters.", "example": 23, "format": "int64", "type": "integer" } }, "required": [ "radiusMeters" ], "type": "object" }, "WorkflowDvirObjectResponseBody": { "description": "A DVIR description", "properties": { "authorSignature": { "$ref": "#/components/schemas/WorkflowAuthorSignatureObjectResponseBody" }, "defects": { "description": "Defects registered for the DVIR.", "items": { "$ref": "#/components/schemas/DvirDefectsObject_v2022_09_13ResponseBody" }, "type": "array" }, "endTime": { "description": "Time when the driver signed and completed this DVIR. UTC timestamp in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "formattedLocation": { "description": "Optional string if your jurisdiction requires a location of the DVIR.", "example": "350 Rhode Island St Ste. 400S, San Francisco, CA 94103", "type": "string" }, "id": { "description": "The unique id of the DVIR", "example": "12345", "type": "string" }, "mechanicNotes": { "description": "The mechanics notes on the DVIR.", "example": "Replaced headlight on passenger side.", "type": "string" }, "needsCorrection": { "description": "Indicates if a defect needs correction.", "example": false, "type": "boolean" }, "odometerMeters": { "description": "The odometer reading in meters.", "example": 91823, "format": "int64", "type": "integer" }, "safetyStatus": { "description": "The condition of vehicle on which DVIR was done. Valid values: `safe`, `unsafe`, `resolved`", "enum": [ "safe", "unsafe", "resolved" ], "example": "unsafe", "type": "string" }, "secondSignature": { "$ref": "#/components/schemas/WorkflowAuthorSignatureObjectResponseBody" }, "startTime": { "description": "Time when driver began filling out this DVIR in RFC 3339 format.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "thirdSignature": { "$ref": "#/components/schemas/WorkflowAuthorSignatureObjectResponseBody" }, "trailer": { "$ref": "#/components/schemas/GoaTrailerTinyResponseResponseBody" }, "type": { "description": "Inspection type of the DVIR. Valid values: `preTrip`, `postTrip`, `mechanic`, `unspecified`", "enum": [ "preTrip", "postTrip", "mechanic", "unspecified" ], "example": "mechanic", "type": "string" } }, "required": [ "authorSignature", "endTime", "id", "needsCorrection", "safetyStatus", "startTime", "type" ], "type": "object" }, "WorkflowDvirSubmittedResponseObjectResponseBody": { "description": "Details specific to DVIR Submitted.", "properties": { "driver": { "$ref": "#/components/schemas/GoaDriverTinyResponseResponseBody" }, "dvir": { "$ref": "#/components/schemas/WorkflowDvirObjectResponseBody" }, "vehicle": { "$ref": "#/components/schemas/VehicleWithGatewayTinyResponseResponseBody" } }, "type": "object" }, "WorkflowGeofenceEventResponseObjectResponseBody": { "properties": { "address": { "$ref": "#/components/schemas/WorkflowAddressEventWithGeofenceObjectResponseBody" }, "vehicle": { "$ref": "#/components/schemas/VehicleWithGatewayTinyResponseResponseBody" } }, "type": "object" }, "WorkflowGeofenceResponseBody": { "description": "The geofence that defines this address and its bounds. This can either be a circle or a polygon, but not both.", "properties": { "circle": { "$ref": "#/components/schemas/WorkflowCircleResponseBody" }, "polygon": { "$ref": "#/components/schemas/WorkflowPolygonResponseBody" }, "settings": { "$ref": "#/components/schemas/SettingsResponseBody" } }, "type": "object" }, "WorkflowIncidentConditionObjectResponseBody": { "description": "Object representing the granular details of the condition. These details will vary depending on the condition.", "properties": { "description": { "description": "Descriptive name of the condition.", "example": "Alert Type Description", "type": "string" }, "details": { "$ref": "#/components/schemas/WorkflowIncidentDetailsObjectResponseBody" }, "triggerId": { "description": "Unique identifier describing the type of condition being represented.", "example": 1000, "format": "int64", "type": "integer" } }, "required": [ "description", "details", "triggerId" ], "type": "object" }, "WorkflowIncidentDetailsObjectResponseBody": { "description": "Object representing the granular details of the condition. These details will vary depending on the condition.", "properties": { "ambientTemperature": { "$ref": "#/components/schemas/AmbientTemperatureResponseBody" }, "cameraConnectorDisconected": { "$ref": "#/components/schemas/CameraConnectorDisconectedResponseBody" }, "cameraStreamIssue": { "$ref": "#/components/schemas/CameraStreamIssueResponseBody" }, "cellSignalLoss": { "$ref": "#/components/schemas/CellSignalLossResponseBody" }, "cloudBackupUploadIssue": { "$ref": "#/components/schemas/CloudBackupUploadIssueResponseBody" }, "dashcamDisconnected": { "$ref": "#/components/schemas/DashcamDisconnectedResponseBody" }, "dataInputValue": { "$ref": "#/components/schemas/DataInputValueResponseBody" }, "deviceMovement": { "$ref": "#/components/schemas/DeviceMovementDataResponseBody" }, "deviceMovementStopped": { "$ref": "#/components/schemas/DeviceMovementStoppedDataResponseBody" }, "driverAppSignIn": { "$ref": "#/components/schemas/DriverAppSignInResponseBody" }, "driverAppSignOut": { "$ref": "#/components/schemas/DriverAppSignOutResponseBody" }, "driverDocumentSubmitted": { "$ref": "#/components/schemas/DriverDocumentSubmittedResponseBody" }, "driverMessageReceived": { "$ref": "#/components/schemas/DriverMessageReceivedResponseBody" }, "driverMessageSent": { "$ref": "#/components/schemas/DriverMessageSentResponseBody" }, "driverRecorded": { "$ref": "#/components/schemas/DriverRecordedResponseBody" }, "dvirSubmittedDevice": { "$ref": "#/components/schemas/WorkflowDvirSubmittedResponseObjectResponseBody" }, "engineIdle": { "$ref": "#/components/schemas/EngineIdleDataResponseBody" }, "engineOff": { "$ref": "#/components/schemas/EngineOffResponseBody" }, "engineOn": { "$ref": "#/components/schemas/EngineOnResponseBody" }, "formSubmitted": { "$ref": "#/components/schemas/FormSubmittedResponseBody" }, "fuelLevelPercentage": { "$ref": "#/components/schemas/FuelLevelPercentageResponseBody" }, "gatewayDisconnected": { "$ref": "#/components/schemas/GatewayDisconnectedResponseBody" }, "gatewayUnplugged": { "$ref": "#/components/schemas/GatewayWithVehicleTinyResponseResponseBody" }, "geofenceEntry": { "$ref": "#/components/schemas/WorkflowGeofenceEventResponseObjectResponseBody" }, "geofenceExit": { "$ref": "#/components/schemas/WorkflowGeofenceEventResponseObjectResponseBody" }, "gpsSignalLoss": { "$ref": "#/components/schemas/GpsSignalLossResponseBody" }, "harshEvent": { "$ref": "#/components/schemas/HarshEventDataResponseBody" }, "hosViolation": { "$ref": "#/components/schemas/HosViolationDataResponseBody" }, "inactivity": { "$ref": "#/components/schemas/InactivityResponseBody" }, "insideGeofence": { "$ref": "#/components/schemas/InsideGeofenceDataResponseBody" }, "issueCreated": { "$ref": "#/components/schemas/IssueCreatedResponseBody" }, "jammingDetected": { "$ref": "#/components/schemas/JammingDetectedResponseBody" }, "motionDetected": { "$ref": "#/components/schemas/MotionDetectedResponseBody" }, "outOfRoute": { "$ref": "#/components/schemas/OutOfRouteResponseBody" }, "outsideGeofence": { "$ref": "#/components/schemas/OutsideGeofenceDataResponseBody" }, "panicButton": { "$ref": "#/components/schemas/PanicButtonResponseBody" }, "personDetected": { "$ref": "#/components/schemas/PersonDetectedResponseBody" }, "reeferTemperature": { "$ref": "#/components/schemas/ReeferTemperatureResponseBody" }, "routeStopArrival": { "$ref": "#/components/schemas/RouteStopDetailsObjectResponseBody" }, "routeStopDeparture": { "$ref": "#/components/schemas/RouteStopDetailsObjectResponseBody" }, "routeStopETA": { "$ref": "#/components/schemas/RouteStopETAResponseBody" }, "scheduledMaintenance": { "$ref": "#/components/schemas/ScheduledMaintenanceDataResponseBody" }, "scheduledMaintenanceByEngineHours": { "$ref": "#/components/schemas/ScheduledMaintenanceByEngineHoursResponseBody" }, "scheduledMaintenanceOdometer": { "$ref": "#/components/schemas/ScheduledMaintenanceOdometerDataResponseBody" }, "severeSpeeding": { "$ref": "#/components/schemas/SevereSpeedingStartedResponseObjectResponseBody" }, "siteGatewayDisconnected": { "$ref": "#/components/schemas/SiteGatewayDisconnectedResponseBody" }, "speed": { "$ref": "#/components/schemas/SpeedDataResponseBody" }, "suddenFuelLevelDrop": { "$ref": "#/components/schemas/SuddenFuelLevelDropResponseBody" }, "suddenFuelLevelRise": { "$ref": "#/components/schemas/SuddenFuelLevelRiseResponseBody" }, "tamperingDetected": { "$ref": "#/components/schemas/TamperingDetectedResponseBody" }, "tireFaults": { "$ref": "#/components/schemas/TireFaultsResponseBody" }, "unassignedDriving": { "$ref": "#/components/schemas/UnassignedDrivingDataResponseBody" }, "vehicleBatteryVoltage": { "$ref": "#/components/schemas/VehicleBatteryVoltageResponseBody" }, "vehicleDefLevelPercentage": { "$ref": "#/components/schemas/VehicleDefLevelPercentageResponseBody" }, "vehicleDetected": { "$ref": "#/components/schemas/VehicleDetectedResponseBody" }, "vehicleFaults": { "$ref": "#/components/schemas/VehicleFaultsResponseBody" } }, "type": "object" }, "WorkflowPolygonResponseBody": { "description": "Information about a polygon geofence. This field is only needed if the geofence is a polygon.", "properties": { "vertices": { "description": "The vertices of the polygon geofence. These geofence vertices describe the perimeter of the polygon, and must consist of at least 3 vertices and less than 40.", "items": { "$ref": "#/components/schemas/VertexResponseBody" }, "type": "array" } }, "type": "object" }, "WorkflowSignatoryUserObjectResponseBody": { "description": "The user who signed the DVIR.", "properties": { "id": { "description": "ID of the user.", "example": "938172", "type": "string" }, "name": { "description": "Name of the user.", "example": "Joe Driver", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "WorkflowTriggerObjectRequestBody": { "description": "The trigger of an alert.", "properties": { "triggerParams": { "$ref": "#/components/schemas/TriggerParamsObjectRequestBody" }, "triggerTypeId": { "description": "The id of the trigger type. Reference the following list for the ids:\n\nAmbient Temperature = 1003\nDVIR Submitted for Asset = 5005\nDriver Recorded = 5027\nSudden Fuel Level Rise = 5034\nSudden Fuel Level Drop = 5035\nTraining Assignment Due Soon = 8003\nTraining Assignment Past Due = 8004\nVehicle Speed = 1000\nFuel Level (Percentage) = 1005\nVehicle DEF Level (Percentage) = 1006\nVehicle Battery = 1007\nGateway Unplugged = 1009\nDashcam Disconnected = 1012\nCamera Connector Disconnected = 1046\nAsset starts moving = 1013\nInside Geofence = 1014\nOutside Geofence = 1020\nUnassigned Driving = 1016\nDriver HOS Violation = 1018\nVehicle Engine Idle = 1019\nAsset Engine On = 1021\nAsset Engine Off = 1022\nHarsh Event = 1023\nScheduled Maintenance = 1024\nScheduled Maintenance by Odometer = 1025\nScheduled Maintenance by Engine Hours = 1026\nOut of Route = 1027\nGPS Signal Loss = 1032\nCell Signal Loss = 1033\nFault Code = 1029\nTire Faults = 1043\nGateway Disconnected = 1030\nPanic Button = 1034\nTampering Detected = 1045\nIf vehicle is severely speeding (as defined by your organization) = 5022\nDriver Document Submitted = 5009\nDriver App Sign In = 5012\nDriver App Sign Out = 5013\nGeofence Entry = 5016\nGeofence Exit = 5017\nRoute Stop ETA Alert = 5018\nScheduled Date And Time = 8001\n", "example": 1000, "format": "int32", "type": "integer" } }, "required": [ "triggerTypeId" ], "type": "object" }, "WorkflowTriggerObjectResponseBody": { "description": "The trigger of an alert.", "properties": { "triggerParams": { "$ref": "#/components/schemas/TriggerParamsObjectResponseBody" }, "triggerTypeId": { "description": "The id of the trigger type. Reference the following list for the ids:\n\nAmbient Temperature = 1003\nDVIR Submitted for Asset = 5005\nDriver Recorded = 5027\nSudden Fuel Level Rise = 5034\nSudden Fuel Level Drop = 5035\nTraining Assignment Due Soon = 8003\nTraining Assignment Past Due = 8004\nVehicle Speed = 1000\nFuel Level (Percentage) = 1005\nVehicle DEF Level (Percentage) = 1006\nVehicle Battery = 1007\nGateway Unplugged = 1009\nDashcam Disconnected = 1012\nCamera Connector Disconnected = 1046\nAsset starts moving = 1013\nInside Geofence = 1014\nOutside Geofence = 1020\nUnassigned Driving = 1016\nDriver HOS Violation = 1018\nVehicle Engine Idle = 1019\nAsset Engine On = 1021\nAsset Engine Off = 1022\nHarsh Event = 1023\nScheduled Maintenance = 1024\nScheduled Maintenance by Odometer = 1025\nScheduled Maintenance by Engine Hours = 1026\nOut of Route = 1027\nGPS Signal Loss = 1032\nCell Signal Loss = 1033\nFault Code = 1029\nTire Faults = 1043\nGateway Disconnected = 1030\nPanic Button = 1034\nTampering Detected = 1045\nIf vehicle is severely speeding (as defined by your organization) = 5022\nDriver Document Submitted = 5009\nDriver App Sign In = 5012\nDriver App Sign Out = 5013\nGeofence Entry = 5016\nGeofence Exit = 5017\nRoute Stop ETA Alert = 5018\nScheduled Date And Time = 8001\n", "example": 1000, "format": "int32", "type": "integer" } }, "required": [ "triggerTypeId" ], "type": "object" }, "_v1_sensors_history_series": { "description": "V1Sensor ID and field to query.", "properties": { "field": { "description": "Field to query.", "enum": [ "ambientTemperature", "cargoPercent", "currentLoop1Raw", "currentLoop1Mapped", "currentLoop2Raw", "currentLoop2Mapped", "doorClosed", "humidity", "pmPowerTotal", "pmPhase1Power", "pmPhase2Power", "pmPhase3Power", "pmPhase1PowerFactor", "pmPhase2PowerFactor", "pmPhase3PowerFactor", "probeTemperature" ], "example": "ambientTemperature", "type": "string" }, "widgetId": { "description": "V1Sensor ID to query.", "example": 1, "format": "int64", "type": "integer" } }, "required": [ "field", "widgetId" ], "type": "object" }, "addressTinyResponse": { "description": "Address book entry, if one exists", "properties": { "id": { "description": "Address book identifier", "example": "123", "type": "string" }, "name": { "description": "Name of this address book entry", "example": "Main Distribution Warehouse", "type": "string" } }, "type": "object" }, "alertObjectDriverResponseBody": { "description": "A driver associated with the alert", "properties": { "attributes": { "description": "List of attributes associated with the entity", "items": { "$ref": "#/components/schemas/GoaAttributeTinyResponseBody" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The ID of the driver", "example": "45646", "type": "string" }, "name": { "description": "The name of the driver.", "example": "Driver Bob", "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the driver.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "alertObjectMachineInputResponseBody": { "description": "A machine input associated with the alert", "properties": { "id": { "description": "The ID of the machine input associated with the alert.", "example": "20170306", "type": "string" }, "name": { "description": "The name of the machine input.", "example": "DataInput-123", "type": "string" } }, "required": [ "id" ], "type": "object" }, "alertObjectOnvifCameraStreamResponseBody": { "description": "A camera stream associated with the alert.", "properties": { "cameraDevice": { "$ref": "#/components/schemas/alertObjectWorkforceCameraDeviceResponseBody" }, "id": { "description": "The ID of the camera stream associated with the alert.", "example": "54321", "type": "string" }, "name": { "description": "The name of the camera stream.", "example": "Stream-123", "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the camera stream.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "alertObjectProductResponseBody": { "description": "The product associated with the alert", "properties": { "shortName": { "description": "The short name associated with the product.", "example": "EM1", "type": "string" } }, "type": "object" }, "alertObjectSensorResponseBody": { "description": "A sensor associated with the alert.", "properties": { "id": { "description": "Thye ID of the sensor associated with the alert", "example": "22222", "type": "string" }, "name": { "description": "The name of the sensor.", "example": "Sensor-123", "type": "string" }, "pinnedDeviceId": { "description": "The Pinned Device ID associated with the alert", "example": "22222", "type": "string" }, "product": { "$ref": "#/components/schemas/alertObjectProductResponseBody" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the sensor.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "alertObjectSitesResponseBody": { "description": "A site associated with the alert.", "properties": { "id": { "description": "The ID of the site associated with the alert", "example": "1111aaaa-11aa-11aa-11aa-111111aaaaaa", "type": "string" }, "name": { "description": "The name of the site", "example": "Site-123", "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Site.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "alertObjectTrailerResponseBody": { "description": "A trailer associated with the alert", "properties": { "attributes": { "description": "List of attributes associated with the entity", "items": { "$ref": "#/components/schemas/GoaAttributeTinyResponseBody" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The ID of the trailer. This is automatically generated when the trailer is created. It cannot be changed.", "example": "494123", "type": "string" }, "name": { "description": "The name of the trailer. This is set by a fleet administrator and will appear in both Samsara’s cloud dashboard as well as the Samsara Driver mobile app. By default, this name is the serial number of the Samsara Asset Gateway. It can be set or updated through the Samsara Dashboard or through the API at any time.", "example": "Trailer-123", "type": "string" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the Trailer.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" }, "trailerSerialNumber": { "description": "The serial number of the trailer.", "example": "8V8WD530FLN016251", "type": "string" } }, "required": [ "id" ], "type": "object" }, "alertObjectVehicleResponseBody": { "description": "The vehicle associated with the alert.", "properties": { "attributes": { "description": "List of attributes associated with the entity", "items": { "$ref": "#/components/schemas/GoaAttributeTinyResponseBody" }, "type": "array" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "The ID of the vehicle.", "example": "494123", "type": "string" }, "name": { "description": "The name of the vehicle.", "example": "Fleet Truck #1", "type": "string" }, "serial": { "description": "The serial number of the gateway installed on the asset.", "example": "GFRV-43N-VGX", "type": "string" }, "staticAssignedDriver": { "$ref": "#/components/schemas/DriverObjectResponseBody" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the vehicle.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" } }, "required": [ "id", "serial" ], "type": "object" }, "alertObjectWorkforceCameraDeviceResponseBody": { "description": "A camera device associated with the alert", "properties": { "id": { "description": "The ID of the camera device associated with the alert", "example": "22222", "type": "string" }, "name": { "description": "The name of the camera device", "example": "Camera-123", "type": "string" }, "sites": { "description": "The list of sites associated with the camera device.", "items": { "$ref": "#/components/schemas/alertObjectSitesResponseBody" }, "type": "array" }, "tags": { "description": "The list of [tags](https://kb.samsara.com/hc/en-us/articles/360026674631-Using-Tags-and-Tag-Nesting) associated with the camera device.", "items": { "$ref": "#/components/schemas/GoaTagTinyResponseResponseBody" }, "type": "array" } }, "required": [ "id" ], "type": "object" }, "assetsInputsAuxInputResponseBody": { "description": "Auxiliary input metadata", "properties": { "name": { "description": "Name of the auxiliary input", "example": "PTO", "type": "string" } }, "required": [ "name" ], "type": "object" }, "assetsInputsResponseResponseBody": { "description": "Full assets inputs objects.", "properties": { "asset": { "$ref": "#/components/schemas/AssetsInputsAssetResponseResponseBody" }, "auxInput": { "$ref": "#/components/schemas/assetsInputsAuxInputResponseBody" }, "happenedAtTime": { "description": "UTC timestamp in RFC 3339 format of the event.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "units": { "description": "Units of the values in the returned data. Valid values: `boolean`, `millivolts`, `microamps`", "enum": [ "boolean", "millivolts", "microamps" ], "example": "boolean", "type": "string" }, "value": { "description": "Value of the data point.", "example": "1", "type": "string" } }, "required": [ "asset", "happenedAtTime", "units", "value" ], "type": "object" }, "attributeTiny": { "description": "A minified attribute.", "properties": { "id": { "description": "The samsara id of the attribute object.", "example": "123e4567-e89b-12d3-a456-426614174000", "type": "string" }, "name": { "description": "Name of attribute.", "example": "License Certifications", "type": "string" }, "numberValues": { "description": "Number values that are associated with this attribute.", "items": { "format": "double", "type": "number" }, "type": "array" }, "stringValues": { "description": "String values that are associated with this attribute.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "attributeValueTiny": { "description": "A minified attribute value", "properties": { "id": { "description": "The samsara id of this value object.", "example": "123e4567-e89b-12d3-a456-426614174000", "type": "string" }, "stringValue": { "description": "The human-readable string for this value.", "example": "CDL", "type": "string" } }, "type": "object" }, "barcodeValueObjectRequestBody": { "properties": { "barcodeType": { "description": "The barcode type that was scanned.", "example": "org.gs1.EAN-13", "type": "string" }, "barcodeValue": { "description": "The captured barcode value.", "example": "0853883003114", "type": "string" } }, "type": "object" }, "barcodeValueObjectResponseBody": { "properties": { "barcodeType": { "description": "The barcode type that was scanned.", "example": "org.gs1.EAN-13", "type": "string" }, "barcodeValue": { "description": "The captured barcode value.", "example": "0853883003114", "type": "string" } }, "type": "object" }, "baseRouteResponseObjectResponseBody": { "properties": { "actualRouteEndTime": { "description": "Actual end time, if it exists, for the route in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "actualRouteStartTime": { "description": "Actual start time, if it exists, for the route in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "driver": { "$ref": "#/components/schemas/GoaDriverTinyResponseResponseBody" }, "externalIds": { "additionalProperties": { "type": "string" }, "description": "A map of external ids", "type": "object" }, "id": { "description": "ID of the route", "example": "342341", "type": "string" }, "name": { "description": "Route name", "example": "Bid 123", "type": "string" }, "notes": { "description": "Notes for the route", "example": "These are my notes", "type": "string" }, "orgLocalTimezone": { "description": "The local timezone, as defined in Settings for your organization. Timezones use [IANA timezone database](https://www.iana.org/time-zones) keys (e.g. `America/Los_Angeles`, `America/New_York`, `Europe/London`, etc.). You can find a mapping of common timezone formats to IANA timezone keys [here](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html).", "example": "America/Los_Angeles", "type": "string" }, "recurringRouteLiveSharingLinks": { "description": "List of shareable, non-expired 'By recurring Route' Live Sharing Links.", "items": { "$ref": "#/components/schemas/LiveSharingLinkResponseObjectResponseBody" }, "type": "array" }, "scheduledRouteEndTime": { "description": "Scheduled end time, if it exists, for the route in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "scheduledRouteStartTime": { "description": "Scheduled start time, if it exists, for the route in RFC 3339 format.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "settings": { "$ref": "#/components/schemas/RouteSettingsResponseBody" }, "stops": { "description": "List of stops along the route", "items": { "$ref": "#/components/schemas/RoutesStopResponseObjectResponseBody" }, "minItems": 2, "type": "array" }, "vehicle": { "$ref": "#/components/schemas/GoaVehicleTinyResponseResponseBody" } }, "required": [ "id" ], "type": "object" }, "behaviorResponseBody": { "description": "Object reference for the behavior within the session.", "properties": { "coachableBehaviorType": { "description": "Coachable behavior type for the behavior in the coaching session. Valid values: `acceleration`, `braking`, `cameraObstruction`, `crash`, `defensiveDriving`, `didNotYield`, `drinkPolicy`, `drowsy`, `eatingDrinking`, `event`, `falsePositive`, `foodPolicy`, `forwardCollisionWarning`, `genericDistraction`, `harshTurn`, `hosViolation`, `idling`, `laneDeparture`, `lateResponse`, `maskPolicy`, `maxSpeed`, `mobileUsage`, `nearCollison`, `noSeatbelt`, `obstructedCamera`, `outwardObstruction`, `passengerPolicy`, `ranRedLight`, `rollingRailroadCrossing`, `rollingStop`, `rollingStop`, `rollover`, `rolloverProtection`, `rolloverProtectionBrakeControlActivated`, `rolloverProtectionEngineControlActivated`, `severeSpeeding`, `smoking`, `speeding`, `tailgating`, `unknown`, `yawControl`, `yawControlBrakeControlActivated`, `yawControlEngineControlActivated`", "enum": [ "acceleration", "braking", "cameraObstruction", "crash", "defensiveDriving", "didNotYield", "drinkPolicy", "drowsy", "eatingDrinking", "event", "falsePositive", "foodPolicy", "forwardCollisionWarning", "genericDistraction", "harshTurn", "hosViolation", "idling", "laneDeparture", "lateResponse", "maskPolicy", "maxSpeed", "mobileUsage", "nearCollison", "noSeatbelt", "obstructedCamera", "outwardObstruction", "passengerPolicy", "ranRedLight", "rollingRailroadCrossing", "rollingStop", "rollingStop", "rollover", "rolloverProtection", "rolloverProtectionBrakeControlActivated", "rolloverProtectionEngineControlActivated", "severeSpeeding", "smoking", "speeding", "tailgating", "unknown", "yawControl", "yawControlBrakeControlActivated", "yawControlEngineControlActivated" ], "example": "forwardCollisionWarning", "type": "string" }, "coachableEvents": { "description": "Object references for the coachableEvents within the behavior. Returned when includeCoachableEvents is 'true'. Capped at 100 coachable events per Coaching session. For sessions where coachable events exceed 100, please visit the Samsara dashboard to address this coaching session. Corresponds to the following unique identifiers: Non-Speeding Safety events - unique Samsara ID of the safety event as 'vehicleId - eventMS'. Speeding events - unique UUID of the event. Day of HOS Violations - unique Samsara ID of the day of violations as '{driverId},{date}'. Idling events - unique UUID of the event.", "items": { "$ref": "#/components/schemas/coachableEventResponseBody" }, "type": "array" }, "id": { "description": "Unique ID for the coaching behavior.", "example": "f5271458-21f9-4a9f-a290-780c6d8840ff", "type": "string" }, "lastCoachedTime": { "description": "Time of last coached date for the same behavior label.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" }, "note": { "description": "Associated note for the coaching behavior. Returned when present.", "example": "Need to wear seatbelt even for short trips.", "type": "string" }, "updatedAtTime": { "description": "Time of coaching behavior update in UTC.", "example": "2019-06-13T19:08:25Z", "format": "date-time", "type": "string" } }, "required": [ "coachableBehaviorType", "id", "lastCoachedTime", "updatedAtTime" ], "type": "object" }, "carrierProposedAssignmentDriverAllOf2ExternalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object", "x-go-gen-location": "models" }, "coachableEventResponseBody": { "description": "Object reference for the coachable event within the behavior.", "properties": { "id": { "description": "Unique ID for an event within the item in a coaching session.", "example": "f5271458-21f9-4a9f-a290-780c6d8840ff", "type": "string" } }, "required": [ "id" ], "type": "object" }, "conditionalFieldSectionObjectResponseBody": { "properties": { "conditionalFieldFirstIndex": { "description": "The index of the first conditional field associated with the triggeringFieldValue in the fieldTypes list.", "example": 1.4423558057019482e+18, "format": "int64", "type": "integer" }, "conditionalFieldLastIndex": { "description": "The index of the last conditional field associated with the triggeringFieldValue in the fieldTypes list.", "example": 8.587732987390647e+18, "format": "int64", "type": "integer" }, "triggeringFieldIndex": { "description": "The index of the multiple choice field in the fieldTypes list that triggers one or more conditional fields.", "example": 7.703795094721638e+18, "format": "int64", "type": "integer" }, "triggeringFieldValue": { "description": "The multiple choice option value that triggers the conditional fields.", "example": "Optiona 1", "type": "string" } }, "type": "object" }, "contactTinyResponse": { "description": "A minified contact object", "properties": { "firstName": { "description": "First name of the contact.", "example": "Jane", "type": "string" }, "id": { "description": "ID of the contact.", "example": "22408", "type": "string" }, "lastName": { "description": "Last name of the contact.", "example": "Jones", "type": "string" } }, "type": "object" }, "dateTimeValueObjectRequestBody": { "description": "The value of a date time field. Only present for date time fields.", "properties": { "dateTime": { "description": "Date time value inin RFC 3339 format.", "example": "1996-02-22T20:14:42Z", "format": "date-time", "type": "string" } }, "type": "object" }, "dateTimeValueObjectResponseBody": { "description": "The value of a date time field. Only present for date time fields.", "properties": { "dateTime": { "description": "Date time value inin RFC 3339 format.", "example": "1975-05-13T14:12:59Z", "format": "date-time", "type": "string" } }, "type": "object" }, "documentResponseObjectResponseBody": { "description": "A single document.", "properties": { "conditionalFieldSections": { "description": "List of the document conditional field sections.", "items": { "$ref": "#/components/schemas/conditionalFieldSectionObjectResponseBody" }, "type": "array" }, "createdAtTime": { "description": "Time the document was created in RFC 3339 format.", "example": "1971-05-04T11:43:21Z", "format": "date-time", "type": "string" }, "documentType": { "$ref": "#/components/schemas/GoaDocumentTypeTinyResponseResponseBody" }, "driver": { "$ref": "#/components/schemas/GoaDriverTinyResponseResponseBody" }, "fields": { "description": "The fields associated with this document.", "items": { "$ref": "#/components/schemas/fieldObjectResponseBody" }, "type": "array" }, "id": { "description": "Universally unique identifier for the document.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "name": { "description": "Name of the document.", "example": "Dropoff Slip 123", "type": "string" }, "notes": { "description": "Notes on the document.", "example": "Missing a crate", "type": "string" }, "route": { "$ref": "#/components/schemas/GoaRouteTinyResponseResponseBody" }, "routeStop": { "$ref": "#/components/schemas/GoaRouteStopTinyResponseResponseBody" }, "state": { "description": "The condition of the document created for the driver. Can be either Required or Submitted. Required documents are pre-populated documents for the Driver to fill out in the Driver App and have not yet been submitted. Submitted documents have been submitted by the driver in the Driver App. Archived documents have been archived by the admin in the cloud dashboard. Valid values: `submitted`, `required`, `archived`", "enum": [ "submitted", "required", "archived" ], "example": "submitted", "type": "string" }, "updatedAtTime": { "description": "Time the document was updated in RFC 3339 format.", "example": "1979-12-10T00:51:01Z", "format": "date-time", "type": "string" }, "vehicle": { "$ref": "#/components/schemas/GoaVehicleTinyResponseResponseBody" } }, "required": [ "createdAtTime", "documentType", "driver", "fields", "id", "state" ], "type": "object" }, "driverTinyResponse": { "description": "A minified driver object.", "properties": { "id": { "description": "ID of the driver.", "example": "88668", "type": "string" }, "name": { "description": "Name of the driver.", "example": "Susan Bob", "type": "string" } }, "type": "object" }, "dvirTrailerDefectsItems": { "properties": { "comment": { "description": "Comment on the defect.", "example": "Air Compressor not working", "type": "string" }, "createdAtTime": { "description": "Time when the defect was created. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "defectType": { "description": "The type of DVIR defect.", "example": "Air Compressor", "type": "string" }, "id": { "description": "ID of the defect.", "example": "18", "type": "string" }, "isResolved": { "description": "Signifies if this defect is resolved.", "example": true, "type": "boolean" }, "mechanicNotes": { "description": "The mechanics notes on the defect.", "example": "Extremely large oddly shaped hole in passenger side window.", "type": "string" }, "mechanicNotesUpdatedAtTime": { "description": "Time when mechanic notes were last updated. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "resolvedAtTime": { "description": "Time when this defect was resolved. Will not be returned if the defect is unresolved. UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "resolvedBy": { "$ref": "#/components/schemas/Defect_resolvedBy" }, "trailer": { "allOf": [ { "description": "The trailer this defect was submitted for.", "type": "object" }, { "description": "A minified trailer object.", "properties": { "id": { "description": "ID of the trailer.", "example": "123456789", "type": "string" }, "name": { "description": "Name of the trailer.", "example": "Midwest Trailer #5", "type": "string" } }, "type": "object" } ], "type": "object" }, "vehicle": { "allOf": [ { "description": "The vehicle this defect was submitted for.", "type": "object" }, { "description": "A minified vehicle object.", "properties": { "ExternalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "id": { "description": "ID of the vehicle.", "example": "123456789", "type": "string" }, "name": { "description": "Name of the vehicle.", "example": "Midwest Truck #4", "type": "string" } }, "type": "object" } ], "type": "object" } }, "required": [ "id", "isResolved" ], "type": "object", "x-go-gen-location": "models" }, "fieldObjectPostRequestBody": { "properties": { "label": { "description": "The name of the field.", "example": "Load weight", "type": "string" }, "type": { "description": "The type of field. Valid values: `photo`, `string`, `number`, `multipleChoice`, `signature`, `dateTime`, `scannedDocument`, `barcode`", "enum": [ "photo", "string", "number", "multipleChoice", "signature", "dateTime", "scannedDocument", "barcode" ], "example": "photo", "type": "string" }, "value": { "$ref": "#/components/schemas/fieldObjectValueRequestBody" } }, "required": [ "label", "type" ], "type": "object" }, "fieldObjectResponseBody": { "properties": { "label": { "description": "The name of the field.", "example": "Load weight", "type": "string" }, "type": { "description": "The type of field. Valid values: `photo`, `string`, `number`, `multipleChoice`, `signature`, `dateTime`, `scannedDocument`, `barcode`", "enum": [ "photo", "string", "number", "multipleChoice", "signature", "dateTime", "scannedDocument", "barcode" ], "example": "photo", "type": "string" }, "value": { "$ref": "#/components/schemas/fieldObjectValueResponseBody" } }, "required": [ "label", "type", "value" ], "type": "object" }, "fieldObjectValueRequestBody": { "description": "The value of the document field. The shape of value depends on the type.", "properties": { "barcodeValue": { "description": "The value of a barcode scanning field. Only present for barcode scanning fields.", "items": { "$ref": "#/components/schemas/barcodeValueObjectRequestBody" }, "type": "array" }, "dateTimeValue": { "$ref": "#/components/schemas/dateTimeValueObjectRequestBody" }, "multipleChoiceValue": { "description": "The value of a multiple choice field. Only present for multiple choice fields.", "items": { "$ref": "#/components/schemas/multipleChoiceValueObjectRequestBody" }, "type": "array" }, "numberValue": { "description": "The value of a number field. Only present for number fields.", "example": 123.456, "format": "double", "type": "number" }, "photoValue": { "description": "The value of a photo field. Only present for photo fields.", "items": { "$ref": "#/components/schemas/photoValueObjectRequestBody" }, "type": "array" }, "scannedDocumentValue": { "description": "The value of a scanned document field. Only present for scanned document fields.", "items": { "$ref": "#/components/schemas/scannedDocumentValueObjectRequestBody" }, "type": "array" }, "signatureValue": { "$ref": "#/components/schemas/signatureValueObjectRequestBody" }, "stringValue": { "description": "The value of a string field. Only present for string fields.", "example": "Red Truck", "type": "string" } }, "type": "object" }, "fieldObjectValueResponseBody": { "description": "The value of the document field. The shape of value depends on the type.", "properties": { "barcodeValue": { "description": "The value of a barcode scanning field. Only present for barcode scanning fields.", "items": { "$ref": "#/components/schemas/barcodeValueObjectResponseBody" }, "type": "array" }, "dateTimeValue": { "$ref": "#/components/schemas/dateTimeValueObjectResponseBody" }, "multipleChoiceValue": { "description": "The value of a multiple choice field. Only present for multiple choice fields.", "items": { "$ref": "#/components/schemas/multipleChoiceValueObjectResponseBody" }, "type": "array" }, "numberValue": { "description": "The value of a number field. Only present for number fields.", "example": 123.456, "format": "double", "type": "number" }, "photoValue": { "description": "The value of a photo field. Only present for photo fields.", "items": { "$ref": "#/components/schemas/photoValueObjectResponseBody" }, "type": "array" }, "scannedDocumentValue": { "description": "The value of a scanned document field. Only present for scanned document fields.", "items": { "$ref": "#/components/schemas/scannedDocumentValueObjectResponseBody" }, "type": "array" }, "signatureValue": { "$ref": "#/components/schemas/signatureValueObjectResponseBody" }, "stringValue": { "description": "The value of a string field. Only present for string fields.", "example": "Red Truck", "type": "string" } }, "type": "object" }, "fieldTypesObjectResponseBody": { "properties": { "fieldType": { "description": "The type of value this field can have. Valid values: `photo`, `string`, `number`, `multipleChoice`, `signature`, `dateTime`, `scannedDocument`, `barcode`", "enum": [ "photo", "string", "number", "multipleChoice", "signature", "dateTime", "scannedDocument", "barcode" ], "example": "photo", "type": "string" }, "label": { "description": "The name of the field type.", "example": "Receipts", "type": "string" }, "multipleChoiceFieldTypeMetaData": { "description": "A list of the multiple choice field option labels.", "items": { "$ref": "#/components/schemas/multipleChoiceFieldTypeMetaDataObjectResponseBody" }, "type": "array" }, "numberFieldTypeMetaData": { "$ref": "#/components/schemas/numberFieldTypeMetaDataObjectResponseBody" }, "requiredField": { "description": "The indicator that states if the field is required.", "example": true, "type": "boolean" }, "signatureFieldTypeMetaData": { "$ref": "#/components/schemas/signatureFieldTypeMetaDataObjectResponseBody" } }, "required": [ "fieldType", "label", "requiredField" ], "type": "object" }, "fleetDeviceObjectResponseBody": { "description": "fleetDeviceObject", "properties": { "id": { "description": "Id of the device", "example": 123456, "format": "int64", "type": "integer" }, "name": { "description": "Name of the device", "example": "My Device", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "gatewayTiny": { "description": "A minified gateway including serial number and model.", "properties": { "model": { "description": "The gateway model", "example": "VG34", "type": "string" }, "serial": { "description": "The serial number of the gateway.", "example": "ABCD-123-XYZ", "type": "string" } }, "type": "object" }, "getDocumentTypeResponseObjectResponseBody": { "properties": { "conditionalFieldSections": { "description": "List of the document type conditional field sections.", "items": { "$ref": "#/components/schemas/conditionalFieldSectionObjectResponseBody" }, "type": "array" }, "fieldTypes": { "description": "The fields associated with this document type.", "items": { "$ref": "#/components/schemas/fieldTypesObjectResponseBody" }, "type": "array" }, "id": { "description": "Universally unique identifier for the document type. This value can be passed in as the documentTypeId when creating a document.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "name": { "description": "Name of the document type.", "example": "Bill's Fuel Receipts", "type": "string" }, "orgId": { "description": "ID for the organization this document type belongs to.", "example": 3.771310580452555e+18, "format": "int64", "type": "integer" } }, "type": "object" }, "industrialAssetObjectResponseBody": { "description": "industrialAssetObject", "properties": { "id": { "description": "Id of the device", "example": "8d218e6c-7a16-4f9f-90f7-cc1d93b9e596", "type": "string" }, "name": { "description": "Name of the industrial asset", "example": "My asset", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "inline_object": { "properties": { "apply_to_future_routes": { "description": "This is only for a recurring route. If set to true, delete all following runs of the route. If set to false, only delete the current route.", "example": true, "type": "boolean" } }, "type": "object" }, "inline_object_1": { "properties": { "duty_status": { "description": "Duty status to set the driver to. The only supported values are 'ON_DUTY' and 'OFF_DUTY'.", "example": "ON_DUTY", "type": "string" }, "location": { "description": "Location to associate the duty status change with.", "example": "Loading dock", "type": "string" }, "remark": { "description": "Remark to associate the duty status change with.", "example": "Beginning On Duty Shift", "type": "string" }, "status_change_at_ms": { "description": "Timestamp that the duty status will begin at specified in milliseconds UNIX time. Defaults to the current time if left blank. This can only be set to up to 8 hours in the past.", "example": 1580834793568, "format": "int64", "type": "number" }, "vehicle_id": { "description": "Vehicle ID to associate the duty status change with.", "example": 1234, "format": "int64", "type": "number" } }, "required": [ "duty_status" ], "type": "object" }, "inline_object_2": { "properties": { "driverIds": { "description": "IDs of the drivers for whom the messages are sent to.", "example": [111, 222, 333], "items": { "example": 555, "format": "int64", "type": "number" }, "type": "array" }, "text": { "description": "The text sent in the message. Max 2500 characters allowed.", "example": "This is a message.", "type": "string" } }, "required": [ "driverIds", "text" ], "type": "object" }, "inline_object_3": { "properties": { "endMs": { "description": "End of the time range, specified in milliseconds UNIX time.", "example": 1462881998034, "type": "integer" }, "startMs": { "description": "Beginning of the time range, specified in milliseconds UNIX time.", "example": 1462878398034, "type": "integer" } }, "required": [ "endMs", "startMs" ], "type": "object" }, "inline_object_4": { "properties": { "sensors": { "description": "List of sensor IDs to query.", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "sensors" ], "type": "object" }, "inline_object_5": { "properties": { "sensors": { "description": "List of sensor IDs to query.", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "sensors" ], "type": "object" }, "inline_object_6": { "properties": { "endMs": { "description": "End of the time range, specified in milliseconds UNIX time.", "example": 1462881998034, "type": "integer" }, "fillMissing": { "default": "withNull", "enum": [ "withNull", "withPrevious" ], "type": "string" }, "series": { "items": { "$ref": "#/components/schemas/_v1_sensors_history_series" }, "maxItems": 40, "type": "array" }, "startMs": { "description": "Beginning of the time range, specified in milliseconds UNIX time.", "example": 1462878398034, "type": "integer" }, "stepMs": { "description": "Time resolution for which data should be returned, in milliseconds. Specifying 3600000 will return data at hour intervals.", "example": 3600000, "type": "integer" } }, "required": [ "endMs", "series", "startMs", "stepMs" ], "type": "object" }, "inline_object_7": { "properties": { "sensors": { "description": "List of sensor IDs to query.", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "sensors" ], "type": "object" }, "inline_object_8": { "properties": { "sensors": { "description": "List of sensor IDs to query.", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "sensors" ], "type": "object" }, "inline_response_200": { "properties": { "data": { "$ref": "#/components/schemas/AssetResponse" } }, "type": "object" }, "inline_response_200_1": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/V1Asset" }, "type": "array" } }, "type": "object" }, "inline_response_200_2": { "properties": { "assets": { "items": { "$ref": "#/components/schemas/V1AssetCurrentLocationsResponse" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/V1Pagination" } }, "type": "object" }, "inline_response_200_3": { "properties": { "data": { "items": { "$ref": "#/components/schemas/V1AssetsReefer" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/V1Pagination" } }, "type": "object" }, "inline_response_200_4": { "properties": { "vehicles": { "items": { "$ref": "#/components/schemas/V1VehicleMaintenance" }, "type": "array" } }, "type": "object" }, "inline_response_200_5": { "description": "A list of messages.", "properties": { "data": { "$ref": "#/components/schemas/V1MessagesResponse" } }, "type": "object" }, "inline_response_200_6": { "description": "A list of created messages.", "properties": { "data": { "$ref": "#/components/schemas/V1Messages" } }, "type": "object" }, "inline_response_200_7": { "properties": { "pagination": { "$ref": "#/components/schemas/V1Pagination" }, "trailers": { "items": { "$ref": "#/components/schemas/V1TrailerAssignmentsResponse" }, "type": "array" } }, "type": "object" }, "inline_response_200_8": { "properties": { "machines": { "items": { "$ref": "#/components/schemas/V1Machine" }, "type": "array" } }, "type": "object" }, "inline_response_200_9": { "properties": { "sensors": { "items": { "$ref": "#/components/schemas/V1Sensor" }, "type": "array" } }, "type": "object" }, "jobLocationResponseObjectResponseBody": { "description": "jobLocation object", "properties": { "address": { "description": "Address of a location", "example": "1990 Alameda st, San Francisco, Ca 94103", "type": "string" }, "latitude": { "description": "Latitude of a location", "example": 37.456345, "format": "double", "type": "number" }, "longitude": { "description": "Longitude of a location", "example": 34.5633749, "format": "double", "type": "number" }, "name": { "description": "Name of a location", "example": "Worksite #1", "type": "string" } }, "required": [ "address", "latitude", "longitude", "name" ], "type": "object" }, "latitude": { "description": "The latitude of the asset in decimal degrees.", "example": 37.765363, "format": "double", "type": "number" }, "location": { "description": "Location object", "properties": { "latitude": { "description": "GPS latitude represented in degrees", "example": 122.142, "format": "double", "type": "number" }, "longitude": { "description": "GPS longitude represented in degrees", "example": -93.343, "format": "double", "type": "number" } }, "required": [ "latitude", "longitude" ], "type": "object" }, "longitude": { "description": "The longitude of the asset in decimal degrees.", "example": -122.403098, "format": "double", "type": "number" }, "multipleChoiceFieldTypeMetaDataObjectResponseBody": { "properties": { "label": { "description": "The option choice label.", "example": "Fuel Receipt", "type": "string" } }, "type": "object" }, "multipleChoiceValueObjectRequestBody": { "properties": { "selected": { "description": "Boolean representing if the choice has been selected.", "example": false, "type": "boolean" }, "value": { "description": "Description of the choice.", "example": "Yes", "type": "string" } }, "type": "object" }, "multipleChoiceValueObjectResponseBody": { "properties": { "selected": { "description": "Boolean representing if the choice has been selected.", "example": false, "type": "boolean" }, "value": { "description": "Description of the choice.", "example": "Yes", "type": "string" } }, "type": "object" }, "numberFieldTypeMetaDataObjectResponseBody": { "description": "The number field metadata.", "properties": { "numberOfDecimalPlaces": { "description": "The number of decimal places allowed for the field.", "example": 3.1674308152126346e+18, "format": "int64", "type": "integer" } }, "type": "object" }, "paginationResponse": { "description": "Pagination parameters.", "properties": { "endCursor": { "description": "Cursor identifier representing the last element in the response. This value should be used in conjunction with a subsequent request's 'after' query parameter. This may be an empty string if there are no more pages left to view.", "example": "MjkY", "format": "string", "type": "string" }, "hasNextPage": { "description": "True if there are more pages of results immediately available after this endCursor.", "example": true, "type": "boolean" } }, "required": [ "endCursor", "hasNextPage" ], "type": "object" }, "photoValueObjectRequestBody": { "properties": { "id": { "description": "Id of the photo.", "example": "f5271458-21f9-4a9f-a290-780c6d8840ff", "type": "string" }, "url": { "description": "Url of the photo.", "example": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456", "type": "string" } }, "type": "object" }, "photoValueObjectResponseBody": { "properties": { "id": { "description": "Id of the photo.", "example": "f5271458-21f9-4a9f-a290-780c6d8840ff", "type": "string" }, "url": { "description": "Url of the photo.", "example": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456", "type": "string" } }, "type": "object" }, "reverseGeo": { "description": "Reverse geocoded information.", "properties": { "formattedLocation": { "description": "Formatted address of the reverse geocoding data.", "example": "16 N Fair Oaks Ave, Pasadena, CA 91103", "type": "string" } }, "type": "object" }, "scannedDocumentValueObjectRequestBody": { "properties": { "id": { "description": "Id of the scanned document.", "example": "f5271458-21f9-4a9f-a290-780c6d8840ff", "type": "string" }, "url": { "description": "Url of the scanned document.", "example": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456", "type": "string" } }, "type": "object" }, "scannedDocumentValueObjectResponseBody": { "properties": { "id": { "description": "Id of the scanned document.", "example": "f5271458-21f9-4a9f-a290-780c6d8840ff", "type": "string" }, "url": { "description": "Url of the scanned document.", "example": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456", "type": "string" } }, "type": "object" }, "sensorResponseBody": { "description": "A sensor", "properties": { "id": { "description": "ID of the sensor", "example": "12345", "type": "string" }, "mac": { "description": "The MAC address of the sensor", "example": "00:00:5e:00:53:af", "type": "string" }, "name": { "description": "The name of the sensor", "example": "Rear temperature sensor", "type": "string" } }, "required": [ "id", "mac", "name" ], "type": "object" }, "signatureFieldTypeMetaDataObjectResponseBody": { "description": "The signature field metadata.", "properties": { "legalText": { "description": "The signature field legal text.", "example": "Verified by signee.", "type": "string" } }, "type": "object" }, "signatureValueObjectRequestBody": { "description": "The value of a signature field. Only present for signature fields.", "properties": { "id": { "description": "Id of the signature field.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "name": { "description": "Name of the signee for a signature field.", "example": "John Smith", "type": "string" }, "signedAtTime": { "description": "Time the signature was captured in RFC 3339 format.", "example": "2010-07-18T06:13:42Z", "format": "date-time", "type": "string" }, "url": { "description": "Url of a signature field's PNG signature image.", "example": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456", "type": "string" } }, "type": "object" }, "signatureValueObjectResponseBody": { "description": "The value of a signature field. Only present for signature fields.", "properties": { "id": { "description": "Id of the signature field.", "example": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7", "type": "string" }, "name": { "description": "Name of the signee for a signature field.", "example": "John Smith", "type": "string" }, "signedAtTime": { "description": "Time the signature was captured in RFC 3339 format.", "example": "2015-01-26T12:08:59Z", "format": "date-time", "type": "string" }, "url": { "description": "Url of a signature field's PNG signature image.", "example": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456", "type": "string" } }, "type": "object" }, "singleDriverEfficiencyByDriverDataObjectResponseBody": { "description": "singleDriverEfficiencyByDriverDataObject", "properties": { "difficultyScore": { "$ref": "#/components/schemas/DriverEfficiencyDifficultyScoreDataObjectResponseBody" }, "driverId": { "description": "ID of the driver.", "example": "driver_001", "type": "string" }, "percentageData": { "$ref": "#/components/schemas/DriverEfficiencyPercentageDataObjectResponseBody" }, "rawData": { "$ref": "#/components/schemas/DriverEfficiencyRawDataObjectResponseBody" }, "scoreData": { "$ref": "#/components/schemas/DriverEfficiencyDataObjectResponseBody" } }, "required": [ "driverId" ], "type": "object" }, "singleDriverEfficiencyByVehicleDataObjectResponseBody": { "description": "singleDriverEfficiencyByVehicleDataObject", "properties": { "difficultyScore": { "$ref": "#/components/schemas/DriverEfficiencyDifficultyScoreDataObjectResponseBody" }, "percentageData": { "$ref": "#/components/schemas/DriverEfficiencyPercentageDataObjectResponseBody" }, "rawData": { "$ref": "#/components/schemas/DriverEfficiencyRawDataObjectResponseBody" }, "scoreData": { "$ref": "#/components/schemas/DriverEfficiencyDataObjectResponseBody" }, "vehicleId": { "description": "ID of the vehicle.", "example": "vehicle_001", "type": "string" } }, "required": [ "vehicleId" ], "type": "object" }, "speedingSeverityLevelResponseBody": { "description": "The settings for a specific speeding severity level.", "properties": { "durationMs": { "description": "The amount of time the vehicle is speeding in this category before being attributed to this level", "example": 60, "format": "int32", "type": "integer" }, "isEnabled": { "default": true, "description": "Indicates the severity level is enabled", "example": true, "type": "boolean" }, "severityLevel": { "description": "The severity level name. Valid values: `light`, `moderate`, `heavy`, `severe`", "enum": [ "light", "moderate", "heavy", "severe" ], "example": "light", "type": "string" }, "speedOverLimitThreshold": { "description": "The minimum speed above the speed limit that will get attributed to this severity level.", "example": 10, "format": "float", "type": "number" } }, "required": [ "durationMs", "isEnabled", "severityLevel", "speedOverLimitThreshold" ], "type": "object" }, "standardDeleteResponse": { "description": "A successful DELETE response is a 204 with no content.", "example": "\u003Cempty content\u003E", "type": "string" }, "standardErrorResponse": { "description": "Error response", "properties": { "message": { "description": "The message of the error.", "example": "An error has occurred.", "type": "string" }, "requestId": { "description": "The ID of the request.", "example": "8916e1c1", "type": "string" } }, "type": "object" }, "tagTinyResponse": { "description": "A minified tag object", "properties": { "id": { "description": "ID of the tag.", "example": "3914", "type": "string" }, "name": { "description": "Name of the tag.", "example": "East Coast", "type": "string" }, "parentTagId": { "description": "If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted.", "example": "4815", "type": "string" } }, "type": "object" }, "time": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string" }, "trailerTinyResponse": { "description": "A minified trailer object.", "properties": { "id": { "description": "ID of the trailer.", "example": "123456789", "type": "string" }, "name": { "description": "Name of the trailer.", "example": "Midwest Trailer #5", "type": "string" } }, "type": "object" }, "userTinyResponse": { "description": "A minified user object.", "properties": { "id": { "description": "ID of the user.", "example": "88668", "type": "string" }, "name": { "description": "Name of the user.", "example": "Susan Bob", "type": "string" } }, "type": "object" }, "vehicleSensorConfigurationAreaResponseBody": { "description": "A configured sensor area on the vehicle with its associated sensors", "properties": { "cargoSensors": { "items": { "$ref": "#/components/schemas/sensorResponseBody" }, "type": "array" }, "humiditySensors": { "items": { "$ref": "#/components/schemas/sensorResponseBody" }, "type": "array" }, "position": { "description": "Position of the area on vehicle Valid values: `back`, `front`, `middle`", "enum": [ "back", "front", "middle" ], "example": "back", "type": "string" }, "temperatureSensors": { "items": { "$ref": "#/components/schemas/sensorResponseBody" }, "type": "array" } }, "required": [ "position" ], "type": "object" }, "vehicleSensorConfigurationDoorResponseBody": { "description": "A door monitor configuration on a vehicle", "properties": { "position": { "description": "Position of the door monitor on the vehicle Valid values: `back`, `left`, `right`", "enum": [ "back", "left", "right" ], "example": "back", "type": "string" }, "sensor": { "$ref": "#/components/schemas/sensorResponseBody" } }, "required": [ "position", "sensor" ], "type": "object" }, "vehicleSensorConfigurationResponseBody": { "description": "The sensors configured on a vehicle", "properties": { "areas": { "description": "Configured sensor areas on the vehicle with its associated sensors", "items": { "$ref": "#/components/schemas/vehicleSensorConfigurationAreaResponseBody" }, "type": "array" }, "doors": { "description": "Configured door monitors on the vehicle", "items": { "$ref": "#/components/schemas/vehicleSensorConfigurationDoorResponseBody" }, "type": "array" } }, "type": "object" }, "vehicleStatsAuxInputTime": { "description": "UTC timestamp in RFC 3339 format. Example: `2020-01-27T07:06:25Z`.", "example": "2020-01-27T07:06:25Z", "type": "string", "x-go-gen-location": "models" }, "vehicleTinyResponse": { "description": "A minified vehicle object.", "properties": { "ExternalIds": { "additionalProperties": { "type": "string" }, "description": "The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.", "example": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "type": "object" }, "id": { "description": "ID of the vehicle.", "example": "123456789", "type": "string" }, "name": { "description": "Name of the vehicle.", "example": "Midwest Truck #4", "type": "string" } }, "type": "object" } }, "securitySchemes": { "AccessTokenHeader": { "type": "http", "scheme": "bearer" } } }, "info": { "description": "\u003Cstyle type=\"text/css\"\u003E\nn {\n padding: 1em;\n width: 100%;\n display: block;\n margin: 28px 0;\n}\nn.info {\n background-color: rgba(0, 51, 160, 0.1);\n}\nn.warning {\n background-color: #fdf6e3;\n}\ni:before {\n margin-right: 6px;\n}\nnh {\n font-size: 1.5rem;\n font-weight: 700;\n line-height: 1.1;\n display: block;\n}\nnb {\n margin-top: 10px;\n padding-left: 22px;\n display: block;\n}\n\u003C/style\u003E\n\n# Overview\n\n\u003Cn class=\"info\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-info-circle\"\u003E\u003C/i\u003E\nSomething new!\n\u003C/nh\u003E\n\u003Cnb\u003E\nWelcome Samsara's new and improved API. Check out our FAQ [here](https://developers.samsara.com/docs/introducing-our-next-generation-api) to see what's changed and learn how to get started.\u003Cbr\u003E\n\u003Cbr\u003E\nWant to access the legacy API docs? You can find them [here](https://www.samsara.com/api-legacy).\u003Cbr\u003E\n\u003Cbr\u003E\n*Note: Because this is a new set of APIs, we have not transitioned all endpoints over to this standard. Endpoints that still use the legacy standards are indicated in the reference documentation. If you can't find an API that you're looking for, we encourage you to look for it in our [legacy API docs](https://www.samsara.com/api-legacy) as we continue to transition all endpoints over. Check back here for updates!*\u003Cbr\u003E\n\u003Cbr\u003E\nSubmit your feedback [here](https://forms.gle/r4bs6HQshQAvBuwv6)!\n\u003C/nb\u003E\n\u003C/n\u003E\n\nSamsara provides API endpoints so that you can build powerful applications and custom solutions with sensor data. Samsara has endpoints available to track and analyze sensors, vehicles, and entire fleets.\n\nThe Samsara API is a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). It uses standard [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) authentication, verbs, and response codes, and it returns [JSON](http://www.json.org/) response bodies. If you're familiar with what you can build with a REST API, then this will be your go-to API reference.\n\nVisit [developers.samsara.com](https://developers.samsara.com) to find getting started guides and an API overview.\n\nIf you have any questions, please visit https://samsara.com/help.\n\n## Endpoints\n\nAll our APIs can be accessed through HTTP requests to URLs like:\n\n```\nhttps://api.samsara.com/\u003Cendpoint\u003E\n```\n\nFor EU customers, this URL will be:\n\n```\nhttps://api.eu.samsara.com/\u003Cendpoint\u003E\n```\n\n\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nNote\n\u003C/nh\u003E\n\u003Cnb\u003E\nLegacy endpoints will have the URL: `https://api.samsara.com/v1/\u003Cendpoint\u003E` or `https://api.eu.samsara.com/v1/\u003Cendpoint\u003E`\n\u003C/nb\u003E\n\u003C/n\u003E\n\n## Authentication\n\nTo authenticate your API request you will need to include your secret token. You can manage your API tokens in the [Dashboard](https://cloud.samsara.com). They are visible under `Settings-\u003EOrganization-\u003EAPI Tokens`.\n\nYour API tokens carry many privileges, so be sure to keep them secure. Do not share your secret API tokens in publicly accessible areas such as GitHub, client-side code, and so on.\n\nAuthentication to the API is performed via Bearer Token in the HTTP Authorization header. Provide your API token as the `access_token` value in an `Authorization: Bearer` header. You do not need to provide a password:\n\n```curl\nAuthorization: Bearer {access_token}\n```\n\nAll API requests must be made over [HTTPS](https://en.wikipedia.org/wiki/HTTPS). Calls made over plain HTTP or without authentication will fail.\n\n### OAuth2\nIf building an application for our marketplace, our API is accessible via. OAuth2 as well.\n\n| Type | Value |\n| ------------- |:-------------:|\n| Security scheme | OAuth2 |\n| OAuth2 Flow | accessCode |\n| Authorization URL | https://api.samsara.com/oauth2/authorize |\n| Token URL | https://api.samsara.com/oauth2/token |\n\n\n\n## Common Patterns\n\nYou can find more info about request methods, response codes, error codes, versioning, pagination, timestamps, and mini-objects [here](https://developers.samsara.com/docs/common-structures).\n", "title": "Samsara API", "version": "2024-11-18" }, "openapi": "3.0.1", "paths": { "/addresses": { "get": { "description": "Returns a list of all addresses in an organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Addresses** under the Addresses category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "listAddresses", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on data to have a created at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "createdAfterTime", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "example": { "data": [ { "addressTypes": [ "yard" ], "contacts": [ { "firstName": "Jane", "id": "22408", "lastName": "Jones" } ], "createdAtTime": "2019-05-18T20:27:35Z", "externalIds": { "maintenanceId": "250020", "payrollId": "ABFS18600" }, "formattedAddress": "350 Rhode Island St, San Francisco, CA", "geofence": { "circle": { "latitude": 37.765363, "longitude": -122.4029238, "radiusMeters": 25 }, "polygon": { "vertices": [ { "latitude": 37.765363, "longitude": -122.403098 }, { "latitude": 38.765363, "longitude": -122.403098 }, { "latitude": 37.765363, "longitude": -123.403098 } ] } }, "id": "22408", "latitude": 37.765363, "longitude": -122.4029238, "name": "Samsara HQ", "notes": "Hours of operation: 8am - 6pm; Truck entrance on the Rhode Island street side.", "tags": [ { "id": "3914", "name": "East Coast", "parentTagId": "4815" } ] } ], "pagination": { "endCursor": "MjkY", "hasNextPage": true } }, "schema": { "$ref": "#/components/schemas/ListAddressesResponse" } } }, "description": "List of all addresses in the organization" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all addresses", "tags": [ "Addresses" ] }, "post": { "description": "Creates a new address in the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Addresses** under the Addresses category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "createAddress", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAddressRequest" } } }, "description": "The address to create.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } }, "description": "Newly created address object with ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Create an address", "tags": [ "Addresses" ], "x-codegen-request-body-name": "address" } }, "/addresses/{id}": { "delete": { "description": "Delete a specific address. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Addresses** under the Addresses category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "deleteAddress", "parameters": [ { "description": "ID of the Address. This can either be the Samsara-provided ID or an external ID. External IDs are customer-specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `crmId:abc123`", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardDeleteResponse" } } }, "description": "A successful DELETE response is a 204 with no content." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Delete an address", "tags": [ "Addresses" ] }, "get": { "description": "Returns a specific address. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Addresses** under the Addresses category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getAddress", "parameters": [ { "description": "ID of the Address. This can either be the Samsara-provided ID or an external ID. External IDs are customer-specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `crmId:abc123`", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } }, "description": "An Address." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Retrieve an address", "tags": [ "Addresses" ] }, "patch": { "description": "Update a specific address. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Addresses** under the Addresses category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "updateAddress", "parameters": [ { "description": "ID of the Address. This can either be the Samsara-provided ID or an external ID. External IDs are customer-specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `crmId:abc123`", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAddressRequest" } } }, "description": "The address fields to update.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressResponse" } } }, "description": "Updated address object with ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update an address", "tags": [ "Addresses" ], "x-codegen-request-body-name": "address" } }, "/alerts/configurations": { "delete": { "description": "Delete an alert configuration.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteConfigurations", "parameters": [ { "description": "The unqiue Samsara id of the alert configuration.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsDeleteConfigurationsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Delete alert configurations.", "tags": [ "Alerts" ] }, "get": { "description": "Get specified Alert Configurations.\n\nThe following trigger types are API enabled and will show up in the results:\nVehicle Speed\nAmbient Temperature\nFuel Level (Percentage)\nVehicle DEF Level (Percentage)\nVehicle Battery\nGateway Unplugged\nDashcam Disconnected\nCamera Connector Disconnected\nAsset starts moving\nInside Geofence\nOutside Geofence\nUnassigned Driving\nDriver HOS Violation\nVehicle Engine Idle\nAsset Engine On\nAsset Engine Off\nHarsh Event\nScheduled Maintenance\nScheduled Maintenance by Odometer\nScheduled Maintenance by Engine Hours\nOut of Route\nGPS Signal Loss\nCell Signal Loss\nFault Code\nTire Faults\nGateway Disconnected\nPanic Button\nTampering Detected\nIf vehicle is severely speeding (as defined by your organization)\nDVIR Submitted for Asset\nDriver Document Submitted\nDriver App Sign In\nDriver App Sign Out\nGeofence Entry\nGeofence Exit\nRoute Stop ETA Alert\nDriver Recorded\nSudden Fuel Level Rise\nSudden Fuel Level Drop\nScheduled Date And Time\nTraining Assignment Due Soon\nTraining Assignment Past Due\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getConfigurations", "parameters": [ { "description": "Filter by the IDs. Returns all if no ids are provided.", "explode": true, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "The status of the alert configuration. Valid values: `all`, `enabled`, `disabled`", "in": "query", "name": "status", "schema": { "default": "all", "enum": [ "all", "enabled", "disabled" ], "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Optional boolean indicating whether to return external IDs on supported entities", "in": "query", "name": "includeExternalIds", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetConfigurationsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get Alert Configurations.", "tags": [ "Alerts" ] }, "patch": { "description": "Updates an alert configuration.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchConfigurations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPatchConfigurationsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Update alert configurations.", "tags": [ "Alerts" ], "x-codegen-request-body-name": "PatchConfigurationsRequestBody" }, "post": { "description": "Creates an alert configuration.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Alerts** under the Alerts category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postConfigurations", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsPostConfigurationsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Create alert configurations.", "tags": [ "Alerts" ], "x-codegen-request-body-name": "PostConfigurationsRequestBody" } }, "/alerts/incidents/stream": { "get": { "description": "Get Alert Incidents for specific Alert Configurations over a specified period of time.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Alerts** under the Alerts category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getIncidents", "parameters": [ { "description": "Required RFC 3339 timestamp that indicates when to begin receiving data. This will be based on updatedAtTime.", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "Required array of alert configuration ids to return incident data for.", "explode": true, "in": "query", "name": "configurationIds", "required": true, "schema": { "items": { "type": "string" }, "maxItems": 50, "minItems": 1, "type": "array" }, "style": "form" }, { "description": "Optional RFC 3339 timestamp to stop receiving data. Defaults to now if not provided. This will be based on updatedAtTime.", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlertsGetIncidentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get Alert Incidents.", "tags": [ "Alerts" ] } }, "/assets": { "delete": { "description": "Delete an existing asset.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Assets** under the Assets category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteAsset", "parameters": [ { "description": "A filter selecting a single asset by id.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsDeleteAssetBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Delete an existing asset.", "tags": [ "Beta APIs" ] }, "get": { "description": "List all assets. Up to 300 assets will be returned per page.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Assets** under the Assets category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "listAssets", "parameters": [ { "description": "The operational context in which the asset interacts with the Samsara system. Examples: Vehicle (eg: truck, bus...), Trailer (eg: dry van, reefer, flatbed...), Powered Equipment (eg: dozer, crane...), Unpowered Equipment (eg: container, dumpster...), or Uncategorized. Valid values: `uncategorized`, `trailer`, `equipment`, `unpowered`, `vehicle`", "in": "query", "name": "type", "schema": { "enum": [ "uncategorized", "trailer", "equipment", "unpowered", "vehicle" ], "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": " A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "updatedAfterTime", "schema": { "type": "string" } }, { "description": "Optional boolean indicating whether to return external IDs on supported entities", "in": "query", "name": "includeExternalIds", "schema": { "type": "boolean" } }, { "description": "Optional boolean indicating whether to return tags on supported entities", "in": "query", "name": "includeTags", "schema": { "type": "boolean" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of asset IDs and External IDs.", "explode": false, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`", "in": "query", "name": "attributeValueIds", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsListAssetsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] List all assets.", "tags": [ "Beta APIs" ] }, "patch": { "description": "Update an existing asset.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Assets** under the Assets category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "updateAsset", "parameters": [ { "description": "A filter selecting a single asset by id.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsUpdateAssetBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Update an existing asset.", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "UpdateAssetRequestBody" }, "post": { "description": "Create a new asset.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Assets** under the Assets category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "createAsset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsCreateAssetBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Create a new asset.", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "CreateAssetRequestBody" } }, "/assets/inputs/stream": { "get": { "description": "This endpoint will return data collected from the inputs of your organization's assets based on the time parameters passed in. Results are paginated. If you include an endTime, the endpoint will return data up until that point. If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. The endpoint will only return data up until the endTime that has been processed by the server at the time of the original request. You will need to request the same [startTime, endTime) range again to receive data for assets processed after the original request time. This endpoint sorts data by time ascending.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Assets** under the Assets category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getAssetsInputs", "parameters": [ { "description": "Comma-separated list of asset IDs. Limited to 100 ID's for each request.", "explode": false, "in": "query", "name": "ids", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Input stat type to query for. Valid values: `auxInput1`, `auxInput2`, `auxInput3`, `auxInput4`, `auxInput5`, `auxInput6`, `auxInput7`, `auxInput8`, `auxInput9`, `auxInput10`, `auxInput11`, `auxInput12`, `auxInput13`, `analogInput1Voltage`, `analogInput2Voltage`, `analogInput1Current`, `analogInput2Current`, `batteryVoltage`", "in": "query", "name": "type", "required": true, "schema": { "enum": [ "auxInput1", "auxInput2", "auxInput3", "auxInput4", "auxInput5", "auxInput6", "auxInput7", "auxInput8", "auxInput9", "auxInput10", "auxInput11", "auxInput12", "auxInput13", "analogInput1Voltage", "analogInput2Voltage", "analogInput1Current", "analogInput2Current", "batteryVoltage" ], "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to never if not provided; if not provided then pagination will not cease, and a valid pagination cursor will always be returned. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": "Optional boolean indicating whether to return external IDs on supported entities", "in": "query", "name": "includeExternalIds", "schema": { "type": "boolean" } }, { "description": "Optional boolean indicating whether to return tags on supported entities", "in": "query", "name": "includeTags", "schema": { "type": "boolean" } }, { "description": "Optional boolean indicating whether to return attributes on supported entities", "in": "query", "name": "includeAttributes", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetsInputsGetAssetsInputsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] List asset inputs data in an organization.", "tags": [ "Beta APIs" ] } }, "/assets/location-and-speed/stream": { "get": { "description": "This endpoint will return asset locations and speed data that has been collected for your organization based on the time parameters passed in. Results are paginated. If you include an endTime, the endpoint will return data up until that point. If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. The endpoint will only return data up until the endTime that has been processed by the server at the time of the original request. You will need to request the same [startTime, endTime) range again to receive data for assets processed after the original request time. This endpoint sorts the time-series data by device.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getLocationAndSpeed", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "default": 512, "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to never if not provided; if not provided then pagination will not cease, and a valid pagination cursor will always be returned. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": "Comma-separated list of asset IDs.", "explode": false, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional boolean indicating whether or not to return the 'speed' object", "in": "query", "name": "includeSpeed", "schema": { "type": "boolean" } }, { "description": "Optional boolean indicating whether or not to return the 'address' object", "in": "query", "name": "includeReverseGeo", "schema": { "type": "boolean" } }, { "description": "Optional boolean indicating whether or not to return the 'geofence' object", "in": "query", "name": "includeGeofenceLookup", "schema": { "type": "boolean" } }, { "description": "Optional boolean indicating whether to return external IDs on supported entities", "in": "query", "name": "includeExternalIds", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationAndSpeedGetLocationAndSpeedBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "List asset location and speed data in an organization.", "tags": [ "Location and Speed" ] } }, "/attributes": { "get": { "description": "Fetch all attributes in an organization associated with either drivers or assets. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Attributes** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getAttributesByEntityType", "parameters": [ { "description": "Denotes the type of entity, driver or asset.", "in": "query", "name": "entityType", "required": true, "schema": { "enum": [ "driver", "asset" ], "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAttributesByEntityTypeResponse" } } }, "description": "All attributes in an organization for an entity type" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all attributes by entity type", "tags": [ "Attributes" ] }, "post": { "description": "Creates a new attribute in the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Attributes** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "createAttribute", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAttributeRequest" } } }, "description": "The attribute to create.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeExpandedResponse" } } }, "description": "Newly created attribute object with ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Create an attribute", "tags": [ "Attributes" ], "x-codegen-request-body-name": "attribute" } }, "/attributes/{id}": { "delete": { "description": "Delete an attribute by id, including all of its applications. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Attributes** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "deleteAttribute", "parameters": [ { "description": "Samsara-provided UUID of the attribute.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Denotes the type of entity, driver or asset.", "in": "query", "name": "entityType", "required": true, "schema": { "enum": [ "driver", "asset" ], "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardDeleteResponse" } } }, "description": "A successful DELETE response is a 204 with no content." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Deleting an attribute", "tags": [ "Attributes" ] }, "get": { "description": "Fetch an attribute by id, including all of its applications. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Attributes** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getAttribute", "parameters": [ { "description": "Samsara-provided UUID of the attribute.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } }, { "description": "Denotes the type of entity, driver or asset.", "in": "query", "name": "entityType", "required": true, "schema": { "enum": [ "driver", "asset" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeExpandedResponse" } } }, "description": "The attribute corresponding to request id." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Retrieve an attribute", "tags": [ "Attributes" ] }, "patch": { "description": "Updates an attribute in the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Attributes** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "updateAttribute", "parameters": [ { "description": "Samsara-provided UUID of the attribute.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAttributeRequest" } } }, "description": "The attribute to update.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeExpandedResponse" } } }, "description": "Newly created attribute object with ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update an attribute", "tags": [ "Attributes" ], "x-codegen-request-body-name": "attribute" } }, "/beta/aemp/Fleet/{pageNumber}": { "get": { "description": "Get a list of equipment following the AEMP ISO 15143-3 standard.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read AEMP** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getAempEquipmentList", "parameters": [ { "description": "The number corresponding to a specific page of paginated results, defaulting to the first page if not provided. The default page size is 100 records.", "in": "path", "name": "pageNumber", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AempEquipmentGetAempEquipmentListBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get a list of AEMP equipment", "tags": [ "Beta APIs" ] } }, "/beta/fleet/drivers/efficiency": { "get": { "description": "Get all driver and associated vehicle efficiency data. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 50 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Fuel & Energy** under the Fuel & Energy category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDriverEfficiency", "parameters": [ { "description": "If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers).", "in": "query", "name": "driverActivationStatus", "schema": { "enum": [ "active", "deactivated" ], "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of driver IDs. Cannot be used with tag filtering or driver status. Example: `driverIds=1234,5678`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Filters summary to drivers based on this comma-separated list of tag IDs. Data from all the drivers' respective vehicles will be included in the summary, regardless of which tag the vehicle is associated with. Should not be provided in addition to `driverIds`. Example: driverTagIds=1234,5678", "explode": false, "in": "query", "name": "driverTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Filters like `driverTagIds` but includes descendants of all the given parent tags. Should not be provided in addition to `driverIds`. Example: `driverParentTagIds=1234,5678`", "explode": false, "in": "query", "name": "driverParentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A start time in RFC 3339 format. The results will be truncated to the hour mark for the provided time. For example, if `startTime` is 2020-03-17T12:06:19Z then the results will include data starting from 2020-03-17T12:00:00Z. The provided start time cannot be in the future. Start time can be at most 31 days before the end time. If the start time is within the last hour, the results will be empty. Default: 24 hours prior to endTime.\n\nNote that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours.", "in": "query", "name": "startTime", "schema": { "format": "date-time", "type": "string" } }, { "description": "An end time in RFC 3339 format. The results will be truncated to the hour mark for the provided time. For example, if `endTime` is 2020-03-17T12:06:19Z then the results will include data up until 2020-03-17T12:00:00Z. The provided end time cannot be in the future. End time can be at most 31 days after the start time. Default: The current time truncated to the hour mark.\n\nNote that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours", "in": "query", "name": "endTime", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficienciesResponse" } } }, "description": "List of all driver and associated vehicle efficiency data" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "[beta] List driver efficiency", "tags": [ "Beta APIs" ] } }, "/beta/fleet/equipment/{id}": { "patch": { "description": "Update an equipment. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard.\n This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource.\n For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchEquipment", "parameters": [ { "description": "The unique Samsara ID of the Equipment. This is automatically generated when the Equipment object is created. It cannot be changed.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPatchEquipmentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Update an equipment", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "PatchEquipmentRequestBody" } }, "/beta/fleet/hos/drivers/eld-events": { "get": { "description": "Get all HOS ELD events in a time range, grouped by driver. Attributes will be populated depending on which ELD Event Type is being returned.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getHosEldEvents", "parameters": [ { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": "If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers). Valid values: `active`, `deactivated`", "in": "query", "name": "driverActivationStatus", "schema": { "default": "active", "enum": [ "active", "deactivated" ], "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 25 objects.", "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 25, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosEldEventsGetHosEldEventsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get driver HOS ELD events", "tags": [ "Beta APIs" ] } }, "/beta/fleet/trailers/stats": { "get": { "description": "Returns the last known stats of all trailers at the given `time`. If no `time` is specified, the current time is used.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 25 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Trailer Statistics** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getTrailerStatsSnapshot", "parameters": [ { "description": "The stat types you want this endpoint to return information on.\n\nYou may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`.\n\n* `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address.\n* `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered.\n* `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius.\n* `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions.\n* `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions.\n* `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions.\n* `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions.\n* `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions.\n* `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`)\n* `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone.\n* `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.", "in": "query", "name": "types", "required": true, "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "trailerIds", "schema": { "type": "string" } }, { "description": " A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 Format. Millisecond precision and timezones are supported.", "in": "query", "name": "time", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsSnapshotBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get trailer stats", "tags": [ "Beta APIs" ] } }, "/beta/fleet/trailers/stats/feed": { "get": { "description": "Follow a feed of trailer stats.\n\nThe first call to this endpoint will provide the most recent stats for each trailer and an `endCursor`.\n\nProviding the `endCursor` value to the `after` query parameter will fetch all updates since the previous API call.\n\nIf `hasNextPage` is false, no new data is immediately available. Please wait a minimum of 5 seconds before making a subsequent request.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 25 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Trailer Statistics** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getTrailerStatsFeed", "parameters": [ { "description": "The stat types you want this endpoint to return information on.\n\nYou may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`.\n\n* `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address.\n* `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered.\n* `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius.\n* `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions.\n* `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions.\n* `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions.\n* `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions.\n* `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions.\n* `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`)\n* `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone.\n* `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.", "in": "query", "name": "types", "required": true, "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "trailerIds", "schema": { "type": "string" } }, { "description": "Decorations add to the primary stats listed in the `types` parameter. For example, if you wish to know the trailer's location whenever the odometer updates, you may set `types=gpsOdometerMeters&decorations=gps`.\n\nYou may list **up to 2** types using comma-separated format. If multiple stats are listed in the types parameter, the decorations will be added to each type. For example: `types=reeferStateZone1,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters&decorations=gps` will list GPS decorations for each reeferStateZone1 reading, each reeferAmbientAirTemperatureMilliC reding, and gpsOdometerMeters reading.\n\nNote that decorations may significantly increase the response payload size.\n\n* `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address.\n* `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered.\n* `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius.\n* `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions.\n* `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions.\n* `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions.\n* `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions.\n* `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions.\n* `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`)\n* `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone.\n* `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.", "in": "query", "name": "decorations", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsFeedBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get trailer stats feed", "tags": [ "Beta APIs" ] } }, "/beta/fleet/trailers/stats/history": { "get": { "description": "Returns trailer stats during the given time range for all trailers. This can be optionally filtered by tags or specific trailer IDs.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Trailer Statistics** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getTrailerStatsHistory", "parameters": [ { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "The stat types you want this endpoint to return information on.\n\nYou may list **up to 3** types using comma-separated format. For example: `types=gps,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters`.\n\n* `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address.\n* `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered.\n* `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius.\n* `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions.\n* `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions.\n* `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions.\n* `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions.\n* `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions.\n* `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`)\n* `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone.\n* `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.", "in": "query", "name": "types", "required": true, "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of trailer IDs and externalIds. Example: `trailerIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "trailerIds", "schema": { "type": "string" } }, { "description": "Decorations add to the primary stats listed in the `types` parameter. For example, if you wish to know the trailer's location whenever the odometer updates, you may set `types=gpsOdometerMeters&decorations=gps`.\n\nYou may list **up to 2** types using comma-separated format. If multiple stats are listed in the types parameter, the decorations will be added to each type. For example: `types=reeferStateZone1,reeferAmbientAirTemperatureMilliC,gpsOdometerMeters&decorations=gps` will list GPS decorations for each reeferStateZone1 reading, each reeferAmbientAirTemperatureMilliC reding, and gpsOdometerMeters reading.\n\nNote that decorations may significantly increase the response payload size.\n\n* `gps`: GPS data including lat/long, heading, speed, and a reverse geocode address.\n* `gpsOdometerMeters`: Odometer reading provided by GPS calculations. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the PATCH /fleet/trailers/{id} endpoint or through the [cloud dashboard](https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading). Odometer readings wthat are manually set will update as GPS trip data is gathered.\n* `reeferAmbientAirTemperatureMilliC`: The ambient air temperature reading of the reefer in millidegree Celsius.\n* `reeferObdEngineSeconds`: The cumulative number of seconds the reefer has run according to onboard diagnostics. Only supported on reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone1`: The supply or discharge air temperature zone 1 in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone2`: The supply or discharge air temperature zone 2 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSupplyAirTemperatureMilliCZone3`: The supply or discharge air temperature zone 3 in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferFuelPercent`: The fuel level of the reefer unit in percentage points (e.g. `99`, `50`, etc). Only supported on reefer solutions.\n* `carrierReeferState`: The overall state of the reefer (`Off`, `On`). Only supported on multizone Carrier reefer solutions.\n* `reeferStateZone1`: The state of the reefer in zone 1. For single zone reefers, this applies tot he single zone. Only supported on multizone reefer solutions.\n* `reeferStateZone2`: The state of the reefer in zone 2. Only supported on multizone reefer solutions.\n* `reeferStateZone3`: The state of the reefer in zone 3. Only supported on multizone reefer solutions.\n* `reeferRunMode`: The operational mode of the reefer (`Start/Stop`, `Continuous`)\n* `reeferAlarms`: Any alarms that are present on the reefer. Only supported on reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone1`: The return air temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone2`: The return air temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferReturnAirTemperatureMilliCZone3`: The return air temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone1`: The set point temperature in zone 1 of the reefer in millidegrees Celsius. For single zone reefers, this applies to the single zone. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone2`: The set point temperature in zone 2 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferSetPointTemperatureMilliCZone3`: The set point temperature in zone 3 of the reefer in millidegrees Celsius. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone1`: The door status in zone 1 of the reefer. For single zone reefers, this applies to the single zone.\n* `reeferDoorStateZone2`: The door status in zone 2 of the reefer. Only supported on multizone reefer solutions.\n* `reeferDoorStateZone3`: The door status in zone 3 of the reefer. Only supported on multizone reefer solutions.", "in": "query", "name": "decorations", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerStatsGetTrailerStatsHistoryBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get trailer stats history", "tags": [ "Beta APIs" ] } }, "/beta/fleet/vehicles/{id}/immobilizer": { "patch": { "description": "Update the engine immobilizer state of a vehicle. This requires an engine immobilizer to be installed on the vehicle gateway.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Vehicle Immobilization** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "updateEngineImmobilizerState", "parameters": [ { "description": "Vehicle ID", "in": "path", "name": "id", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateRequestBody" } } }, "required": true }, "responses": { "202": { "content": { }, "description": "Accepted response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerUpdateEngineImmobilizerStateBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Update engine immobilizer state of a vehicle.", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "UpdateEngineImmobilizerStateRequestBody" } }, "/beta/industrial/jobs": { "delete": { "description": "Deletes an existing job.\n\nTo use this endpoint, select **Write Jobs** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteJob", "parameters": [ { "description": "A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`).", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsDeleteJobBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Deletes an existing job", "tags": [ "Beta APIs" ] }, "get": { "description": "Fetches jobs based on id/uuid or provided filters.\n\nTo use this endpoint, select **Read Jobs** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getJobs", "parameters": [ { "description": "A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`).", "in": "query", "name": "id", "schema": { "type": "string" } }, { "description": " A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startDate", "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endDate", "schema": { "type": "string" } }, { "description": "IndustrialAssetId in STRING format. (Example: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`).", "explode": true, "in": "query", "name": "industrialAssetIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "FleetDeviceId in INTEGER format. (Example: `123456`).", "explode": true, "in": "query", "name": "fleetDeviceIds", "schema": { "items": { "type": "integer" }, "type": "array" }, "style": "form" }, { "description": "A job status in STRING format. Job statuses can be one of three (ignores case): `\"active\", \"scheduled\", \"completed\"` Valid values: `active`, `scheduled`, `completed`", "in": "query", "name": "status", "schema": { "enum": [ "active", "scheduled", "completed" ], "type": "string" } }, { "description": "Customer name to filter by", "in": "query", "name": "customerName", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsGetJobsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Fetches all jobs", "tags": [ "Beta APIs" ] }, "patch": { "description": "Patches an existing job and returns it.\n\nTo use this endpoint, select **Write Jobs** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchJob", "parameters": [ { "description": "A jobId or uuid in STRING format. JobId must be prefixed with `jobId:`(Examples: `\"8d218e6c-7a16-4f9f-90f7-cc1d93b9e596\"`, `\"jobId:98765\"`).", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsPatchJobBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Patches a job", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "PatchJobRequestBody" }, "post": { "description": "Creates a new job and returns it.\n\nTo use this endpoint, select **Write Jobs** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "createJob", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsCreateJobBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Create a job", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "CreateJobRequestBody" } }, "/cameras/media": { "get": { "description": "This endpoint returns a list of all uploaded media (video and still images) matching query parameters, with a maximum query range of one day. Additional media can be retrieved with the [Create a media retrieval request](https://developers.samsara.com/reference/postmediaretrieval) endpoint, and they will be included in the list after they are uploaded. Urls provided by this endpoint expire in 8 hours.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Media Retrieval** under the Safety & Cameras category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "listUploadedMedia", "parameters": [ { "description": "A filter on the data based on this comma-separated list of vehicle IDs and externalIds. You can specify up to 20 vehicles. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "vehicleIds", "required": true, "schema": { "type": "string" } }, { "description": "An optional list of desired camera inputs for which to return captured media. If empty, media for all available inputs will be returned. Possible options include: dashcamRoadFacing, dashcamDriverFacing, analog.", "explode": true, "in": "query", "name": "inputs", "schema": { "items": { "enum": [ "dashcamRoadFacing", "dashcamDriverFacing", "analog" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "An optional list of desired media types for which to return captured media. If empty, media for all available media types will be returned. Possible options include: IMAGE, VIDEO_HIGH_RES.", "explode": true, "in": "query", "name": "mediaTypes", "schema": { "items": { "enum": [ "IMAGE", "VIDEO_HIGH_RES" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "An optional list of desired trigger reasons for which to return captured media. If empty, media for all available trigger reasons will be returned. Possible options include: api, panicButton, periodicStill, safetyEvent, tripEndStill, tripStartStill, videoRetrieval. videoRetrieval represents media captured for a dashboard video retrieval request.", "explode": true, "in": "query", "name": "triggerReasons", "schema": { "items": { "enum": [ "api", "panicButton", "periodicStill", "safetyEvent", "tripEndStill", "tripStartStill", "videoRetrieval" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. End time cannot be more than 24 hours after startTime. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "An optional timestamp in RFC 3339 format that can act as a cursor to track which media has previously been retrieved; only media whose availableAtTime comes after this parameter will be returned. Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00", "in": "query", "name": "availableAfterTime", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalListUploadedMediaBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] List uploaded media by time range.", "tags": [ "Beta APIs" ] } }, "/cameras/media/retrieval": { "get": { "description": "This endpoint returns media information corresponding to a retrieval ID. Retrieval IDs are associated to prior [media retrieval requests](https://developers.samsara.com/reference/postmediaretrieval). Urls provided by this endpoint expire in 8 hours.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Media Retrieval** under the Safety & Cameras category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getMediaRetrieval", "parameters": [ { "description": "Retrieval ID associated with this media capture request. Examples: 2308cec4-82e0-46f1-8b3c-a3592e5cc21e", "in": "query", "name": "retrievalId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalGetMediaRetrievalBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get details for a media retrieval request", "tags": [ "Beta APIs" ] }, "post": { "description": "This endpoint creates an asynchronous request to upload certain media from a device. The closest available media to the requested timestamp is returned. Images and high-res videos are supported; other types of media (e.g. hyperlapse, low-res) are planned to be supported in the future. Currently, only unblurred media is supported. If a device is offline, the requested media will be uploaded once it comes back online. Quota limits for media requests will be enforced in GA, but not in closed beta.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Media Retrieval** under the Safety & Cameras category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postMediaRetrieval", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MediaRetrievalPostMediaRetrievalBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Create a media retrieval request", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "PostMediaRetrievalRequestBody" } }, "/coaching/driver-coach-assignments": { "get": { "description": "This endpoint will return coach assignments for your organization based on the parameters passed in. Results are paginated.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Coaching** under the Coaching category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDriverCoachAssignment", "parameters": [ { "description": "Optional string of comma separated IDs of the drivers. This can be either a unique Samsara driver ID or an external ID for the driver.", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional string of comma separated IDs of the coaches.", "explode": false, "in": "query", "name": "coachIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional boolean indicating whether to return external IDs on supported entities", "in": "query", "name": "includeExternalIds", "schema": { "type": "boolean" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsGetDriverCoachAssignmentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get driver coach assignments.", "tags": [ "Coaching" ] }, "put": { "description": "This endpoint will update an existing or create a new coach-to-driver assignment for your organization based on the parameters passed in. This endpoint should only be used for existing Coach to Driver assignments. In order to remove a driver-coach-assignment for a given driver, set coachId to null\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Coaching** under the Coaching category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "putDriverCoachAssignment", "parameters": [ { "description": "Required string ID of the driver. This is a unique Samsara ID of a driver.", "in": "query", "name": "driverId", "required": true, "schema": { "type": "string" } }, { "description": "Optional string ID of the coach. This is a unique Samsara user ID. If not provided, existing coach assignment will be removed.", "in": "query", "name": "coachId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverCoachAssignmentsPutDriverCoachAssignmentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Put driver coach assignments.", "tags": [ "Coaching" ] } }, "/coaching/sessions/stream": { "get": { "description": "This endpoint will return coaching sessions for your organization based on the time parameters passed in. Results are paginated by sessions. If you include an endTime, the endpoint will return data up until that point. If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Coaching** under the Coaching category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getCoachingSessions", "parameters": [ { "description": "Optional string of comma separated driver IDs. If driver ID is present, sessions for the specified driver(s) will be returned.", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional string of comma separated user IDs. If coach ID is present, sessions for the specified coach(s) will be returned for either assignedCoach or completedCoach. If both driverId(s) and coachId(s) are present, sessions with specified driver(s) and coach(es) will be returned.", "explode": false, "in": "query", "name": "coachIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional string of comma separated statuses. Valid values: “upcoming”, “completed”, “deleted”.", "explode": false, "in": "query", "name": "sessionStatuses", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional boolean to control whether behaviors will include coachableEvents in the response. Defaults to false.", "in": "query", "name": "includeCoachableEvents", "schema": { "type": "boolean" } }, { "description": "Required RFC 3339 timestamp that indicates when to begin receiving data. Value is compared against `updatedAtTime`", "in": "query", "name": "startTime", "required": true, "schema": { "format": "date-time", "type": "string" } }, { "description": "Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes. If endTime is set the same as startTime, the most recent data point before that time will be returned per asset. Value is compared against `updatedAtTime`", "in": "query", "name": "endTime", "schema": { "format": "date-time", "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Optional boolean indicating whether to return external IDs on supported entities", "in": "query", "name": "includeExternalIds", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CoachingSessionsGetCoachingSessionsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get coaching sessions.", "tags": [ "Coaching" ] } }, "/contacts": { "get": { "description": "Returns a list of all contacts in an organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "listContacts", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListContactsResponse" } } }, "description": "List of all contacts" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all contacts", "tags": [ "Contacts" ] }, "post": { "description": "Add a contact to the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "createContact", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateContactRequest" } } }, "description": "The contact create parameters.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } }, "description": "Contact was successfully added." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Create a contact", "tags": [ "Contacts" ], "x-codegen-request-body-name": "contact" } }, "/contacts/{id}": { "delete": { "description": "Delete the given contact. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "deleteContact", "parameters": [ { "description": "Unique identifier for the contact.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardDeleteResponse" } } }, "description": "A successful DELETE response is a 204 with no content." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Delete a contact", "tags": [ "Contacts" ] }, "get": { "description": "Get a specific contact's information. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Alert Contacts** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getContact", "parameters": [ { "description": "Unique identifier for the contact.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } }, "description": "Returns the specified contact." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Retrieve a contact", "tags": [ "Contacts" ] }, "patch": { "description": "Update a specific contact's information. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Alert Contacts** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "updateContact", "parameters": [ { "description": "Unique identifier for the contact.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateContactRequest" } } }, "description": "Updates to the contact.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactResponse" } } }, "description": "Updated contact object with given ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update a contact", "tags": [ "Contacts" ], "x-codegen-request-body-name": "contact" } }, "/defect-types": { "get": { "description": "Get DVIR defect types.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Defect Types** under the Maintenance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDefectTypes", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "default": 512, "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "A filter on the data based on this comma-separated list of defect type IDs.", "explode": false, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectTypeGetDefectTypesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get DVIR defect types.", "tags": [ "Maintenance" ] } }, "/defects/stream": { "get": { "description": "Stream DVIR defects.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Defects** under the Maintenance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "streamDefects", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 200 objects.", "in": "query", "name": "limit", "schema": { "default": 200, "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Required RFC 3339 timestamp to begin the feed or history by `updatedAtTime` at `startTime`.", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes.", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": "Optional boolean indicating whether to return external IDs on supported entities", "in": "query", "name": "includeExternalIds", "schema": { "type": "boolean" } }, { "description": "Boolean value for whether filter defects by resolved status.", "in": "query", "name": "isResolved", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirDefectStreamDefectsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Stream DVIR defects.", "tags": [ "Maintenance" ] } }, "/devices": { "get": { "description": "Returns all installed cameras (CM3x), vehicle gateways (VGs), and asset gateways (AGs) and their health information within an organization. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Devices API enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Devices** under the Devices category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDevices", "parameters": [ { "description": "Optional string of comma separated device models. Valid values: `CM31`, `CM32`, `CM33`, `CM34`, `VG34`, `VG34M`, `VG34EU`, `VG34FN`, `VG54NA`, `VG54EU`, `VG55NA`, `VG55EU`, `AG24`, `AG24EU`, `AG26`, `AG26EU`, `AG45`, `AG45EU`, `AG46`, `AG46EU`, `AG46P`, `AG46PEU`, `AG51`, `AG51EU`, `AG52`, `AG52EU`, `AG53`, `AG53EU`", "explode": false, "in": "query", "name": "models", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional string of comma separated device health statuses. Valid values: `healthy`, `needsAttention`, `needsReplacement`, `dataPending`.", "explode": false, "in": "query", "name": "healthStatuses", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional boolean to control whether device health information is returned in the response. Defaults to false.", "in": "query", "name": "includeHealth", "schema": { "type": "boolean" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 100 objects.", "in": "query", "name": "limit", "schema": { "default": 100, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevicesGetDevicesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] List devices.", "tags": [ "Beta APIs" ] } }, "/driver-trailer-assignments": { "get": { "description": "Get currently active driver-trailer assignments for driver.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDriverTrailerAssignments", "parameters": [ { "description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`", "explode": false, "in": "query", "name": "driverIds", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Optional boolean indicating whether to return external IDs on supported entities", "in": "query", "name": "includeExternalIds", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsGetDriverTrailerAssignmentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get currently active driver-trailer assignments for driver.", "tags": [ "Beta APIs" ] }, "patch": { "description": "Update an existing driver-trailer assignment.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "updateDriverTrailerAssignment", "parameters": [ { "description": "Samsara ID for the assignment.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsUpdateDriverTrailerAssignmentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Update an existing driver-trailer assignment.", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "UpdateDriverTrailerAssignmentRequestBody" }, "post": { "description": "Create a new driver-trailer assignment\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "createDriverTrailerAssignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailerAssignmentsCreateDriverTrailerAssignmentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Create a new driver-trailer assignment", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "CreateDriverTrailerAssignmentRequestBody" } }, "/drivers/qr-codes": { "delete": { "description": "Revoke requested driver's currently active QR code.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Drivers** under the Drivers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteDriverQrCode", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeRequestBody" } } }, "required": true }, "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesDeleteDriverQrCodeBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Revoke driver's QR code", "tags": [ "Driver QR Codes" ], "x-codegen-request-body-name": "DeleteDriverQrCodeRequestBody" }, "get": { "description": "Get details for requested driver(s) QR code, used for driver trip assignment.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Drivers** under the Drivers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDriversQrCodes", "parameters": [ { "description": "String of comma separated driver IDs. List of driver - QR codes for specified driver(s) will be returned.", "explode": false, "in": "query", "name": "driverIds", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesGetDriversQrCodesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get driver QR codes", "tags": [ "Driver QR Codes" ] }, "post": { "description": "Assign a new QR code for the requested driver. Return error if an active QR code already exists.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Drivers** under the Drivers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "createDriverQrCode", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverQrCodesCreateDriverQrCodeBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Create new QR code for driver", "tags": [ "Driver QR Codes" ], "x-codegen-request-body-name": "CreateDriverQrCodeRequestBody" } }, "/dvirs/stream": { "get": { "description": "Returns a history/feed of changed DVIRs by updatedAtTime between startTime and endTime parameters. In case of missing `endTime` parameter it will return a never ending stream of data.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read DVIRs** under the Maintenance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDvirs", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 200 objects.", "in": "query", "name": "limit", "schema": { "default": 200, "maximum": 200, "minimum": 1, "type": "integer" } }, { "description": "Optional boolean indicating whether to return external IDs on supported entities", "in": "query", "name": "includeExternalIds", "schema": { "type": "boolean" } }, { "description": "Required RFC 3339 timestamp to begin the feed or history by `updatedAtTime` at `startTime`.", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "Optional RFC 3339 timestamp. If not provided then the endpoint behaves as an unending feed of changes.", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": "Optional list of safety statuses. Valid values: [safe, unsafe, resolved]", "explode": true, "in": "query", "name": "safetyStatus", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirGetDvirsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Stream DVIRs", "tags": [ "Maintenance" ] } }, "/fleet/carrier-proposed-assignments": { "get": { "description": "Show the assignments created by the POST fleet/carrier-proposed-assignments. This endpoint will only show the assignments that are active for drivers and currently visible to them in the driver app. Once a proposed assignment has been accepted, the endpoint will not return any data. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Carrier-Proposed Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "listCarrierProposedAssignments", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "If specified, shows assignments that will be active at this time. Defaults to now, which would show current active assignments. In RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "activeTime", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCarrierProposedAssignmentResponse" } } }, "description": "Returns the assignments that drivers would see in the future, if any." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Retrieve assignments", "tags": [ "Carrier Proposed Assignments" ] }, "post": { "description": "Creates a new assignment that a driver can later use. Each driver can only have one future assignment. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Carrier-Proposed Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "createCarrierProposedAssignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCarrierProposedAssignmentRequest" } } }, "description": "The assignment to create.", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierProposedAssignmentResponse" } } }, "description": "Return the created assignment" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Create an assignment", "tags": [ "Carrier Proposed Assignments" ], "x-codegen-request-body-name": "carrierProposedAssignment" } }, "/fleet/carrier-proposed-assignments/{id}": { "delete": { "description": "Permanently delete an assignment. You can only delete assignments that are not yet active. To override a currently active assignment, create a new empty one, instead. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Carrier-Proposed Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "deleteCarrierProposedAssignment", "parameters": [ { "description": "ID of the assignment.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardDeleteResponse" } } }, "description": "A successful DELETE response is a 204 with no content." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Delete an assignment", "tags": [ "Carrier Proposed Assignments" ] } }, "/fleet/defects/history": { "get": { "description": "**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/streamdefects) instead. The endpoint will continue to function as documented.** \n\nReturns a list of DVIR defects in an organization, filtered by creation time. The maximum time period you can query for is 30 days. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Defects** under the Maintenance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDvirDefects", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). *The maximum time period you can query for is 30 days.*", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). *The maximum time period you can query for is 30 days.*", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "A filter on the data based on resolution status. Example: `isResolved=true`", "in": "query", "name": "isResolved", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefectsResponse" } } }, "description": "List of all DVIR defects in the organization" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "[legacy] Get all defects", "tags": [ "Legacy APIs" ] } }, "/fleet/defects/{id}": { "patch": { "description": "Updates a given defect. Can be used to resolve a defect by marking its `isResolved` field to `true`. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Defects** under the Maintenance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "updateDvirDefect", "parameters": [ { "description": "ID of the defect.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefectPatch" } } }, "description": "The DVIR defect fields to update.", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefectResponse" } } }, "description": "Return the modified defect entity" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update a defect", "tags": [ "Maintenance" ], "x-codegen-request-body-name": "defect" } }, "/fleet/document-types": { "get": { "description": "Returns a list of the organization document types. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentTypesByOrgId).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDocumentTypes", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentTypesGetDocumentTypesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Fetch document types", "tags": [ "Documents" ] } }, "/fleet/documents": { "get": { "description": "Get all documents for the given time range. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentsByOrgId).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDocuments", "parameters": [ { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "ID of the document template type.", "in": "query", "name": "documentTypeId", "schema": { "type": "string" } }, { "description": "Query by document creation time (`created`) or updated time (`updated`). Defaults to `created`.", "in": "query", "name": "queryBy", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Fetch all documents", "tags": [ "Documents" ] }, "post": { "description": "Creates a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/createDriverDocument).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postDocument", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsPostDocumentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Create document", "tags": [ "Documents" ], "x-codegen-request-body-name": "PostDocumentRequestBody" } }, "/fleet/documents/pdfs": { "post": { "description": "Request creation of a document PDF. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "generateDocumentPdf", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentPdfGenerationRequest" } } }, "description": "Specifies the document for which to generate a PDF.", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentPdfGenerationResponse" } } }, "description": "Newly created PDF generation job." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response." } }, "summary": "Create a document PDF", "tags": [ "Documents" ], "x-codegen-request-body-name": "document" } }, "/fleet/documents/pdfs/{id}": { "get": { "description": "Returns generation job status and download URL for a PDF. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDocumentPdf", "parameters": [ { "description": "ID of the pdf.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentPdfQueryResponse" } } }, "description": "Document PDF job status and download URL." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Query a document PDF", "tags": [ "Documents" ] } }, "/fleet/documents/{id}": { "delete": { "description": "Deletes a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/deleteDriverDocumentByIdAndDriverId).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Documents** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteDocument", "parameters": [ { "description": "ID of the document to delete", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsDeleteDocumentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Delete document", "tags": [ "Documents" ] }, "get": { "description": "Returns a single document. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDriverDocumentByIdAndDriverId).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 25 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Documents** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDocument", "parameters": [ { "description": "ID of the document", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsGetDocumentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Fetch document", "tags": [ "Documents" ] } }, "/fleet/driver-vehicle-assignments": { "delete": { "description": "Delete driver assignments that were created using the `POST fleet/driver-vehicle-assignments` endpoint for the requested vehicle in the requested time range.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteDriverVehicleAssignments", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody" } } }, "required": true }, "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Delete API generated driver-vehicle assignments", "tags": [ "Driver-Vehicle Assignments" ], "x-codegen-request-body-name": "DeleteDriverVehicleAssignmentsRequestBody" }, "get": { "description": "Get all driver-vehicle assignments for the requested drivers or vehicles in the requested time range. To fetch driver-vehicle assignments out of the vehicle trips' time ranges, assignmentType needs to be specified. Note: this endpoint replaces past endpoints to fetch assignments by driver or by vehicle. Visit [this migration guide](https://developers.samsara.com/docs/migrating-from-driver-vehicle-assignment-or-vehicle-driver-assignment-endpoints) for more information.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDriverVehicleAssignments", "parameters": [ { "description": "Option to filter by drivers or vehicles. Valid values: `drivers`, `vehicles`", "in": "query", "name": "filterBy", "required": true, "schema": { "enum": [ "drivers", "vehicles" ], "type": "string" } }, { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: \"key:value\". For example, \"maintenanceId:250020\".", "explode": false, "in": "query", "name": "vehicleIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " A filter on the data based on this comma-separated list of driver tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "driverTagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of vehicle tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "vehicleTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Specifies which assignment type to filter by. Valid values: `HOS`, `idCard`, `static`, `faceId`, `tachograph`, `safetyManual`, `RFID`, `trailer`, `external`, `qrCode`", "in": "query", "name": "assignmentType", "schema": { "enum": [ "HOS", "idCard", "static", "faceId", "tachograph", "safetyManual", "RFID", "trailer", "external", "qrCode" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get all driver-vehicle assignments", "tags": [ "Driver-Vehicle Assignments" ] }, "patch": { "description": "Update driver assignments that were created using the `POST fleet/driver-vehicle-assignments`. Vehicle Id, Driver Id, and Start Time must match an existing assignment.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "updateDriverVehicleAssignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody" } } }, "required": true }, "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentResponseBody" } } }, "description": "Accepted response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Update API generated driver-vehicle assignments", "tags": [ "Driver-Vehicle Assignments" ], "x-codegen-request-body-name": "UpdateDriverVehicleAssignmentRequestBody" }, "post": { "description": "Assign vehicle drive-time to a driver via API. For a step-by-step instruction on how to leverage this endpoint, see [this guide](https://developers.samsara.com/docs/creating-driver-vehicle-assignments)\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "createDriverVehicleAssignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentResponseBody" } } }, "description": "Created response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Create a new driver-vehicle assignment", "tags": [ "Driver-Vehicle Assignments" ], "x-codegen-request-body-name": "CreateDriverVehicleAssignmentRequestBody" } }, "/fleet/drivers": { "get": { "description": "Get all drivers in organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Drivers** under the Drivers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "listDrivers", "parameters": [ { "description": "If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers).", "in": "query", "name": "driverActivationStatus", "schema": { "enum": [ "active", "deactivated" ], "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`", "explode": false, "in": "query", "name": "attributeValueIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "updatedAfterTime", "schema": { "type": "string" } }, { "description": "A filter on data to have a created at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "createdAfterTime", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDriversResponse" } } }, "description": "List of all driver objects." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all drivers", "tags": [ "Drivers" ] }, "post": { "description": "Add a driver to the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Drivers** under the Drivers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "createDriver", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDriverRequest" } } }, "description": "The driver to create.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverResponse" } } }, "description": "Newly created driver object, with Samsara-generated ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Create a driver", "tags": [ "Drivers" ], "x-codegen-request-body-name": "driver" } }, "/fleet/drivers/remote-sign-out": { "post": { "description": "Sign out a driver from the Samsara Driver App\n\nTo access this endpoint, your organization must have the Samsara Platform Premier license.\n\nNote: Sign out requests made while a logged-in driver does not have internet connection will not log the driver out. A success response will still be provided and the driver will be logged out once they have internet connection.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Driver Remote Signout** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postDriverRemoteSignout", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverRemoteSignoutPostDriverRemoteSignoutBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Sign out a driver", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "PostDriverRemoteSignoutRequestBody" } }, "/fleet/drivers/tachograph-activity/history": { "get": { "description": "Returns all known tachograph activity for all specified drivers in the time range. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Tachograph (EU)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDriverTachographActivity", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. It can't be more than 30 days past startTime. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of driver IDs. Example: `driverIds=1234,5678`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverTachographActivityResponse" } } }, "description": "List of all driver tachograph activities in a specified time range." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get driver tachograph activity", "tags": [ "Tachograph (EU Only)" ] } }, "/fleet/drivers/tachograph-files/history": { "get": { "description": "Returns all known tachograph files for all specified drivers in the time range. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 50 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Tachograph (EU)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDriverTachographFiles", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of driver IDs. Example: `driverIds=1234,5678`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TachographDriverFilesResponse" } } }, "description": "List of all driver tachograph files in a specified time range." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get tachograph driver files", "tags": [ "Tachograph (EU Only)" ] } }, "/fleet/drivers/vehicle-assignments": { "get": { "description": "**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getdrivervehicleassignments) instead. The endpoint will continue to function as documented.** Get all vehicle assignments for the requested drivers in the requested time range. The only type of assignment supported right now are assignments created through the driver app.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 25 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDriversVehicleAssignments", "parameters": [ { "description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). The maximum allowed startTime-endTime range is 7 days.", "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). The maximum allowed startTime-endTime range is 7 days.", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of driver tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of driver parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": "If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers). Valid values: `active`, `deactivated`", "in": "query", "name": "driverActivationStatus", "schema": { "default": "active", "enum": [ "active", "deactivated" ], "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversVehicleAssignmentsGetDriversVehicleAssignmentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[legacy] Get all vehicles assigned to a set of drivers", "tags": [ "Legacy APIs" ] } }, "/fleet/drivers/{id}": { "get": { "description": "Get information about a driver. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Drivers** under the Drivers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDriver", "parameters": [ { "description": "ID of the driver. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `payrollId:ABFS18600`", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverResponse" } } }, "description": "Returns the specified driver." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Retrieve a driver", "tags": [ "Drivers" ] }, "patch": { "description": "Update a specific driver's information. This can also be used to activate or de-activate a given driver by setting the driverActivationStatus field. If the driverActivationStatus field is 'deactivated' then the user can also specify the deactivatedAtTime. The deactivatedAtTime cannot be more than 6 months in the past and must not come before the dirver's latest active HOS log. It will be considered an error if deactivatedAtTime is provided with a driverActivationStatus of active. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Drivers** under the Drivers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "updateDriver", "parameters": [ { "description": "ID of the driver. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `payrollId:ABFS18600`", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDriverRequest" } } }, "description": "Updates to the driver properties.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverResponse" } } }, "description": "Updated driver object, with ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update a driver", "tags": [ "Drivers" ], "x-codegen-request-body-name": "driver" } }, "/fleet/dvirs": { "post": { "description": "Creates a new mechanic DVIR in the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "createDvir", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDvirRequest" } } }, "description": "The DVIR to create.", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirResponse" } } }, "description": "Newly created DVIR." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Create a mechanic DVIR", "tags": [ "Maintenance" ], "x-codegen-request-body-name": "dvir" } }, "/fleet/dvirs/history": { "get": { "description": "**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getdvirs) instead. The endpoint will continue to function as documented.** \n\n Returns a list of all DVIRs in an organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read DVIRs** under the Maintenance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDvirHistory", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirsListResponse" } } }, "description": "List of all DVIRs in the organization" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "[legacy] Get all DVIRs", "tags": [ "Legacy APIs" ] } }, "/fleet/dvirs/{id}": { "patch": { "description": "Resolves a given DVIR by marking its `isResolved` field to `true`. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write DVIRs** under the Maintenance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "updateDvir", "parameters": [ { "description": "ID of the DVIR.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDvirRequest" } } }, "description": "The dvir fields to update.", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DvirResponse" } } }, "description": "Updated dvir object with ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Resolve a DVIR", "tags": [ "Maintenance" ], "x-codegen-request-body-name": "dvir" } }, "/fleet/equipment": { "get": { "description": "Returns a list of all equipment in an organization. Equipment objects represent powered assets connected to a [Samsara AG26](https://www.samsara.com/products/models/ag26) via an APWR, CAT, or J1939 cable. They are automatically created with a unique Samsara Equipment ID whenever an AG26 is activated in your organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "listEquipment", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentListResponse" } } }, "description": "List of all equipment objects, and pagination information" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all equipment", "tags": [ "Equipment" ] } }, "/fleet/equipment/locations": { "get": { "description": "Returns last known locations for all equipment. This can be optionally filtered by tags or specific equipment IDs. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getEquipmentLocations", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678`", "explode": false, "in": "query", "name": "equipmentIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentLocationsResponse" } } }, "description": "The most recent equipment locations and pagination information" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get most recent locations for all equipment", "tags": [ "Equipment" ] } }, "/fleet/equipment/locations/feed": { "get": { "description": "Follow a continuous feed of all equipment locations from Samsara AG26s.\n\nYour first call to this endpoint will provide you with the most recent location for each unit of equipment and a `pagination` object that contains an `endCursor`.\n\nYou can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment location updates since that `endCursor`.\n\nIf `hasNextPage` is `false`, no updates are readily available yet. We'd suggest waiting a minimum of 5 seconds before requesting updates. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getEquipmentLocationsFeed", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678`", "explode": false, "in": "query", "name": "equipmentIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentLocationsListResponse" } } }, "description": "The feed of equipment locations and pagination information" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Follow feed of equipment locations", "tags": [ "Equipment" ] } }, "/fleet/equipment/locations/history": { "get": { "description": "Returns historical equipment locations during the given time range. This can be optionally filtered by tags or specific equipment IDs. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getEquipmentLocationsHistory", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678`", "explode": false, "in": "query", "name": "equipmentIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentLocationsListResponse" } } }, "description": "Historical equipment locations and pagination information" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get historical equipment locations", "tags": [ "Equipment" ] } }, "/fleet/equipment/stats": { "get": { "description": "Returns the last known stats for all equipment. This can be optionally filtered by tags or specific equipment IDs. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 150 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getEquipmentStats", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678`", "explode": false, "in": "query", "name": "equipmentIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "The types of equipment stats you want to query. Currently, you may submit up to 3 types.\r\n\r\n- `engineRpm`: The revolutions per minute of the engine.\r\n- `fuelPercents`: The percent of fuel in the unit of equipment.\r\n- `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics.\r\n- `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: \r\n - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) \r\n - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). \r\n- `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard.\r\n- `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`.\r\n- `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`.\r\n- `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`.\r\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. \r\n- `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling.", "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "gatewayEngineStates", "obdEngineStates", "fuelPercents", "engineRpm", "gatewayEngineSeconds", "obdEngineSeconds", "gatewayJ1939EngineSeconds", "gpsOdometerMeters", "gps", "engineTotalIdleTimeMinutes" ], "format": "string", "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentStatsResponse" } } }, "description": "The most recent equipment stats and pagination information" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get most recent stats for all equipment", "tags": [ "Equipment" ] } }, "/fleet/equipment/stats/feed": { "get": { "description": "Follow a continuous feed of all equipment stats from Samsara AG26s.\n\nYour first call to this endpoint will provide you with the most recent stats for each unit of equipment and a `pagination` object that contains an `endCursor`.\n\nYou can provide the `endCursor` to subsequent calls via the `after` parameter. The response will contain any equipment stats updates since that `endCursor`.\n\nIf `hasNextPage` is `false`, no updates are readily available yet. Each stat type has a different refresh rate, but in general we'd suggest waiting a minimum of 5 seconds before requesting updates. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 150 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getEquipmentStatsFeed", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678`", "explode": false, "in": "query", "name": "equipmentIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "The types of equipment stats you want to query. Currently, you may submit up to 3 types.\r\n\r\n- `engineRpm`: The revolutions per minute of the engine.\r\n- `fuelPercents`: The percent of fuel in the unit of equipment.\r\n- `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics.\r\n- `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: \r\n - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) \r\n - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). \r\n- `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard.\r\n- `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`.\r\n- `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`.\r\n- `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`.\r\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. \r\n- `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling.", "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "gatewayEngineStates", "obdEngineStates", "fuelPercents", "engineRpm", "gatewayEngineSeconds", "obdEngineSeconds", "gatewayJ1939EngineSeconds", "gpsOdometerMeters", "gps", "engineTotalIdleTimeMinutes" ], "format": "string", "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentStatsListResponse" } } }, "description": "The feed of equipment stats and pagination information" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Follow a feed of equipment stats", "tags": [ "Equipment" ] } }, "/fleet/equipment/stats/history": { "get": { "description": "Returns historical equipment status during the given time range. This can be optionally filtered by tags or specific equipment IDs. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 150 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getEquipmentStatsHistory", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of equipment IDs. Example: `equipmentIds=1234,5678`", "explode": false, "in": "query", "name": "equipmentIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "The types of equipment stats you want to query. Currently, you may submit up to 3 types.\r\n\r\n- `engineRpm`: The revolutions per minute of the engine.\r\n- `fuelPercents`: The percent of fuel in the unit of equipment.\r\n- `obdEngineSeconds`: The number of seconds the engine has been running since it was new. This value is provided directly from on-board diagnostics.\r\n- `gatewayEngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the asset gateway has been receiving power with an offset provided manually through the Samsara cloud dashboard. This is supported with the following hardware configurations: \r\n - AG24/AG26/AG46P + APWR cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required) \r\n - AG52 + BPWR/BEQP cable ([Auxiliary engine configuration](https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs#UUID-d514abff-d10a-efaf-35d9-e10fa6c4888d) required). \r\n- `gatewayJ1939EngineSeconds`: An approximation of the number of seconds the engine has been running since it was new, based on the amount of time the AG26 device is receiving power via J1939/CAT cable and an offset provided manually through the Samsara cloud dashboard.\r\n- `obdEngineStates`: The state of the engine read from on-board diagnostics. Can be `Off`, `On`, or `Idle`.\r\n- `gatewayEngineStates`: An approximation of engine state based on readings the AG26 receives from the aux/digio cable. Can be `Off` or `On`.\r\n- `gpsOdometerMeters`: An approximation of odometer reading based on GPS calculations since the AG26 was activated, and a manual odometer offset provided in the Samsara cloud dashboard. Valid values: `Off`, `On`.\r\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address. \r\n- `engineTotalIdleTimeMinutes`: Total time in minutes that the engine has been idling.", "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "gatewayEngineStates", "obdEngineStates", "fuelPercents", "engineRpm", "gatewayEngineSeconds", "obdEngineSeconds", "gatewayJ1939EngineSeconds", "gpsOdometerMeters", "gps", "engineTotalIdleTimeMinutes" ], "format": "string", "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentStatsListResponse" } } }, "description": "Historical equipment stats and pagination information" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get historical equipment stats", "tags": [ "Equipment" ] } }, "/fleet/equipment/{id}": { "get": { "description": "Retrieves the unit of equipment with the given Samsara ID. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getEquipment", "parameters": [ { "description": "Samsara ID of the Equipment.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentResponse" } } }, "description": "The specified equipment object" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Retrieve a unit of equipment", "tags": [ "Equipment" ] } }, "/fleet/hos/clocks": { "get": { "description": "Get the current HOS status for all drivers. Note that this includes inactive as well as active drivers. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getFleetHosLogsSummary). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getHosClocks", "parameters": [ { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of driver IDs. Example: `driverIds=1234,5678`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosClocksResponse" } } }, "description": "List of current HOS clock information for the specified drivers." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get HOS clocks", "tags": [ "Hours of Service" ] } }, "/fleet/hos/daily-logs": { "get": { "description": "Get summarized daily Hours of Service charts for the specified drivers.\n\nThe time range for a log is defined by the `driver`'s `eldDayStartHour`. This value is configurable per driver.\n\nThe `startDate` and `endDate` parameters indicate the date range you'd like to retrieve daily logs for. A daily log will be returned if its `startTime` is on any of the days within in this date range (inclusive of `startDate` and `endDate`).\n\n**Note:** If data is still being uploaded from the Samsara Driver App, it may not be completely reflected in the response from this endpoint. The best practice is to wait a couple of days before querying this endpoint to make sure that all data from the Samsara Driver App has been uploaded.\n\nIf you are using the legacy version of this endpoint and looking for its documentation, you can find it [here](https://www.samsara.com/api-legacy#operation/getFleetDriversHosDailyLogs).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getHosDailyLogs", "parameters": [ { "description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " A start date in YYYY-MM-DD. This is a date only without an associated time. Example: `2019-06-13`. This is a required field", "in": "query", "name": "startDate", "schema": { "type": "string" } }, { "description": " An end date in YYYY-MM-DD. This is a date only without an associated time. Must be greater than or equal to the start date. Example: `2019-07-21`. This is a required field", "in": "query", "name": "endDate", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": "If value is `deactivated`, only drivers that are deactivated will appear in the response. This parameter will default to `active` if not provided (fetching only active drivers). Valid values: `active`, `deactivated`", "in": "query", "name": "driverActivationStatus", "schema": { "default": "active", "enum": [ "active", "deactivated" ], "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Expands the specified value(s) in the response object. Expansion populates additional fields in an object, if supported. Unsupported fields are ignored. To expand multiple fields, input a comma-separated list.\n\nValid value: `vehicle` Valid values: `vehicle`", "in": "query", "name": "expand", "schema": { "enum": [ "vehicle" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsGetHosDailyLogsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get all driver HOS daily logs", "tags": [ "Hours of Service" ] } }, "/fleet/hos/logs": { "get": { "description": "Returns HOS logs between a given `startTime` and `endTime`. The logs can be further filtered using tags or by providing a list of driver IDs (including external IDs). The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getFleetHosLogs).\n\n**Note:** If data is still being uploaded from the Samsara Driver App, it may not be completely reflected in the response from this endpoint. The best practice is to wait a couple of days before querying this endpoint to make sure that all data from the Samsara Driver App has been uploaded. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getHosLogs", "parameters": [ { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of driver IDs. Example: `driverIds=1234,5678`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosLogsResponse" } } }, "description": "List of the last known HOS log entries for the specified drivers." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get HOS logs", "tags": [ "Hours of Service" ] } }, "/fleet/hos/violations": { "get": { "description": "Get active Hours of Service violations for the specified drivers.\n\nThe day object time range for a violation is defined by the `driver`'s `eldDayStartHour`. This value is configurable per driver.\n\nThe `startTime` and `endTime` parameters indicate the datetime range you'd like to retrieve violations for. A violation will be returned if its `violationStartTime` falls within this datetime range (inclusive of `startTime` and `endTime`) \n\n**Note:** The following are all the violation types with a short explanation about what each of them means: `californiaMealbreakMissed` (Missed California Meal Break), `cycleHoursOn` (Cycle Limit), `cycleOffHoursAfterOnDutyHours` (Cycle 2 Limit), `dailyDrivingHours` (Daily Driving Limit), `dailyOffDutyDeferralAddToDay2Consecutive` (Daily Off-Duty Deferral: Add To Day2 Consecutive), `dailyOffDutyDeferralNotPartMandatory` (Daily Off-Duty Deferral: Not Part Of Mandatory), `dailyOffDutyDeferralTwoDayDrivingLimit` (Daily Off-Duty Deferral: 2 Day Driving Limit), `dailyOffDutyDeferralTwoDayOffDuty` (Daily Off-Duty Deferral: 2 Day Off Duty), `dailyOffDutyNonResetHours` (Daily Off-Duty Time: Non-Reset), `dailyOffDutyTotalHours` (Daily Off-Duty Time), `dailyOnDutyHours` (Daily On-Duty Limit), `mandatory24HoursOffDuty` (24 Hours of Off Duty required), `restbreakMissed` (Missed Rest Break), `shiftDrivingHours` (Shift Driving Limit), `shiftHours` (Shift Duty Limit), `shiftOnDutyHours` (Shift On-Duty Limit), `unsubmittedLogs` (Missing Driver Certification)\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getHosViolations", "parameters": [ { "description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": "A filter on violations data based on the violation type enum. Supported types: `NONE, californiaMealbreakMissed, cycleHoursOn, cycleOffHoursAfterOnDutyHours, dailyDrivingHours, dailyOffDutyDeferralAddToDay2Consecutive, dailyOffDutyDeferralNotPartMandatory, dailyOffDutyDeferralTwoDayDrivingLimit, dailyOffDutyDeferralTwoDayOffDuty, dailyOffDutyNonResetHours, dailyOffDutyTotalHours, dailyOnDutyHours, mandatory24HoursOffDuty, restbreakMissed, shiftDrivingHours, shiftHours, shiftOnDutyHours, unsubmittedLogs`", "explode": false, "in": "query", "name": "types", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosViolationsGetHosViolationsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get all driver HOS violations", "tags": [ "Hours of Service" ] } }, "/fleet/reports/drivers/fuel-energy": { "get": { "description": "Get fuel and energy efficiency driver reports for the requested time range.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Fuel & Energy** under the Fuel & Energy category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getFuelEnergyDriverReports", "parameters": [ { "description": "A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.", "in": "query", "name": "startDate", "required": true, "schema": { "type": "string" } }, { "description": "An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.", "in": "query", "name": "endDate", "required": true, "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyDriverReportsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get fuel and energy efficiency driver reports.", "tags": [ "Fuel and Energy" ] } }, "/fleet/reports/ifta/jurisdiction": { "get": { "description": "Get all jurisdiction IFTA reports for the requested time duration. Data is returned in your organization's defined timezone.\n\n**Note:** The most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read IFTA (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getIftaJurisdictionReports", "parameters": [ { "description": " The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`", "in": "query", "name": "year", "required": true, "schema": { "maximum": 2100, "minimum": 2015, "type": "integer" } }, { "description": " The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`", "in": "query", "name": "month", "schema": { "enum": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ], "type": "string" } }, { "description": " The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`", "in": "query", "name": "quarter", "schema": { "enum": [ "Q1", "Q2", "Q3", "Q4" ], "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`", "in": "query", "name": "jurisdictions", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`", "in": "query", "name": "fuelType", "schema": { "enum": [ "Unspecified", "A55", "Biodiesel", "CompressedNaturalGas", "Diesel", "E85", "Electricity", "Ethanol", "Gasohol", "Gasoline", "Hydrogen", "LiquifiedNaturalGas", "M85", "Methanol", "Propane", "Other" ], "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "vehicleIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaJurisdictionReportsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get IFTA jurisdiction reports.", "tags": [ "IFTA" ] } }, "/fleet/reports/ifta/vehicle": { "get": { "description": "Get all vehicle IFTA reports for the requested time duration. Data is returned in your organization's defined timezone.\n\n**Note:** The most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 25 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read IFTA (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getIftaVehicleReports", "parameters": [ { "description": " The year of the requested IFTA report summary. Must be provided with a month or quarter param. Example: `year=2021`", "in": "query", "name": "year", "required": true, "schema": { "maximum": 2100, "minimum": 2015, "type": "integer" } }, { "description": " The month of the requested IFTA report summary. Can not be provided with the quarter param. Example: `month=January` Valid values: `January`, `February`, `March`, `April`, `May`, `June`, `July`, `August`, `September`, `October`, `November`, `December`", "in": "query", "name": "month", "schema": { "enum": [ "January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" ], "type": "string" } }, { "description": " The quarter of the requested IFTA report summary. Can not be provided with the month param. Q1: January, February, March. Q2: April, May, June. Q3: July, August, September. Q4: October, November, December. Example: `quarter=Q1` Valid values: `Q1`, `Q2`, `Q3`, `Q4`", "in": "query", "name": "quarter", "schema": { "enum": [ "Q1", "Q2", "Q3", "Q4" ], "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of jurisdictions. Example: `jurisdictions=GA`", "in": "query", "name": "jurisdictions", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of IFTA fuel types. Example: `fuelType=Diesel` Valid values: `Unspecified`, `A55`, `Biodiesel`, `CompressedNaturalGas`, `Diesel`, `E85`, `Electricity`, `Ethanol`, `Gasohol`, `Gasoline`, `Hydrogen`, `LiquifiedNaturalGas`, `M85`, `Methanol`, `Propane`, `Other`", "in": "query", "name": "fuelType", "schema": { "enum": [ "Unspecified", "A55", "Biodiesel", "CompressedNaturalGas", "Diesel", "E85", "Electricity", "Ethanol", "Gasohol", "Gasoline", "Hydrogen", "LiquifiedNaturalGas", "M85", "Methanol", "Propane", "Other" ], "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "vehicleIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaVehicleReportsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get IFTA vehicle reports.", "tags": [ "IFTA" ] } }, "/fleet/reports/vehicle/idling": { "get": { "description": "Get all vehicle idling reports for the requested time duration.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 25 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Fuel & Energy** under the Fuel & Energy category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getVehicleIdlingReports", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "default": 512, "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "vehicleIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": "A filter on the data based on power take-off being active or inactive.", "in": "query", "name": "isPtoActive", "schema": { "type": "boolean" } }, { "description": "A filter on the data based on a minimum idling duration.", "in": "query", "name": "minIdlingDurationMinutes", "schema": { "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdlingReportsGetVehicleIdlingReportsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get vehicle idling reports.", "tags": [ "Idling" ] } }, "/fleet/reports/vehicles/fuel-energy": { "get": { "description": "Get fuel and energy efficiency vehicle reports for the requested time range.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 25 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Fuel & Energy** under the Fuel & Energy category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getFuelEnergyVehicleReports", "parameters": [ { "description": "A start date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.", "in": "query", "name": "startDate", "required": true, "schema": { "type": "string" } }, { "description": "An end date in RFC 3339 format. This parameter ignores everything (i.e. hour, minutes, seconds, nanoseconds, etc.) besides the date and timezone. If no time zone is passed in, then the UTC time zone will be used. This parameter is inclusive, so data on the date specified will be considered. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. For example, 2022-07-13T14:20:50.52-07:00 is a time in Pacific Daylight Time.", "in": "query", "name": "endDate", "required": true, "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "vehicleIds", "schema": { "type": "string" } }, { "description": "The type of energy used by the vehicle. Valid values: `fuel`, `hybrid`, `electric`", "in": "query", "name": "energyType", "schema": { "enum": [ "fuel", "hybrid", "electric" ], "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelEnergyGetFuelEnergyVehicleReportsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get fuel and energy efficiency vehicle reports.", "tags": [ "Fuel and Energy" ] } }, "/fleet/routes": { "get": { "description": "Returns multiple routes. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/fetchAllDispatchRoutes).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "fetchRoutes", "parameters": [ { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "default": 512, "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRoutesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Fetch all routes", "tags": [ "Routes" ] }, "post": { "description": "Create a route. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/createDispatchRoute).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "createRoute", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesCreateRouteBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Create a route", "tags": [ "Routes" ], "x-codegen-request-body-name": "CreateRouteRequestBody" } }, "/fleet/routes/audit-logs/feed": { "get": { "description": "Subscribes to a feed of immutable, append-only updates for routes. The initial request to this feed endpoint returns a cursor, which can be used on the next request to fetch updated routes that have had state changes since that request.\n\nThe legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/fetchAllRouteJobUpdates).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getRoutesFeed", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Expands the specified value(s) in the response object. Expansion populates additional fields in an object, if supported. Unsupported fields are ignored. To expand multiple fields, input a comma-separated list.\n\nValid value: `route` Valid values: `route`", "in": "query", "name": "expand", "schema": { "enum": [ "route" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesGetRoutesFeedBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get route updates", "tags": [ "Routes" ] } }, "/fleet/routes/{id}": { "delete": { "description": "Delete a dispatch route and its associated stops.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteRoute", "parameters": [ { "description": "ID of the route. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `payrollId:ABFS18600`", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesDeleteRouteBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Delete a route.", "tags": [ "Routes" ] }, "get": { "description": "Returns a single route. The legacy version of this endpoint can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/getDispatchRouteById).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 25 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Routes** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "fetchRoute", "parameters": [ { "description": "ID of the route. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `payrollId:ABFS18600`", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesFetchRouteBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Fetch a route", "tags": [ "Routes" ] }, "patch": { "description": "Update a route. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard.\n This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource.\n For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array.\n\nThe legacy version of this endpoint (which uses PUT instead of PATCH) can be found at [samsara.com/api-legacy](https://www.samsara.com/api-legacy#operation/updateDispatchRouteById).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchRoute", "parameters": [ { "description": "ID of the route. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `payrollId:ABFS18600`", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoutesPatchRouteBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Update a route", "tags": [ "Routes" ], "x-codegen-request-body-name": "PatchRouteRequestBody" } }, "/fleet/safety-events": { "get": { "description": "Fetch safety events for the organization in a given time period. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getSafetyEvents", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`", "explode": false, "in": "query", "name": "vehicleIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsListResponse" } } }, "description": "List of safety events from given time period." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all safety events.", "tags": [ "Safety" ] } }, "/fleet/safety-events/audit-logs/feed": { "get": { "description": "Get continuous safety events. The safety activity event feed offers a change-log for safety events. Use this endpoint to subscribe to safety event changes. See documentation below for all supported change-log types.\n\n| ActivityType | Description |\n| ----------- | ----------- |\n| CreateSafetyEventActivityType | a new safety event is processed by Samsara |\n| BehaviorLabelActivityType | a label is added or removed from a safety event |\n| CoachingStateActivityType | a safety event coaching state is updated |\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getSafetyActivityEventFeed", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetyEventsGetSafetyActivityEventFeedBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Fetches safety activity event feed", "tags": [ "Safety" ] } }, "/fleet/settings/compliance": { "get": { "description": "Get organization's compliance settings, including carrier name, office address, and DOT number\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getComplianceSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetComplianceSettingsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get compliance settings", "tags": [ "Settings" ] }, "patch": { "description": "Update organization's compliance settings, including carrier name, office address, and DOT number\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write ELD Compliance Settings (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchComplianceSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchComplianceSettingsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Update compliance settings", "tags": [ "Settings" ], "x-codegen-request-body-name": "PatchComplianceSettingsRequestBody" } }, "/fleet/settings/driver-app": { "get": { "description": "Get driver app settings.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Driver App Settings** under the Drivers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDriverAppSettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsGetDriverAppSettingsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get driver app settings", "tags": [ "Settings" ] }, "patch": { "description": "Update driver app settings.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Driver App Settings** under the Drivers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchDriverAppSettings", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SettingsPatchDriverAppSettingsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Update driver app settings", "tags": [ "Settings" ], "x-codegen-request-body-name": "PatchDriverAppSettingsRequestBody" } }, "/fleet/settings/safety": { "get": { "description": "Get safety settings\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getSafetySettings", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SafetySettingsGetSafetySettingsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get safety settings", "tags": [ "Settings" ] } }, "/fleet/trailers": { "get": { "description": "List all trailers.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Trailers** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "listTrailers", "parameters": [ { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "default": 512, "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersListTrailersBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "List all trailers", "tags": [ "Trailers" ] }, "post": { "description": "Creates a new trailer asset.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Trailers** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "createTrailer", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersCreateTrailerBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Creates a new trailer asset", "tags": [ "Trailers" ], "x-codegen-request-body-name": "CreateTrailerRequestBody" } }, "/fleet/trailers/{id}": { "delete": { "description": "Delete a trailer with the given ID.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Trailers** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteTrailer", "parameters": [ { "description": "Unique identifier for the trailer to delete.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersDeleteTrailerBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Delete a trailer", "tags": [ "Trailers" ] }, "get": { "description": "Retrieve a trailer with given ID.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Trailers** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getTrailer", "parameters": [ { "description": "ID of the trailer. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: \"key:value\". For example, \"maintenanceId:250020\".", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersGetTrailerBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Retrieve a trailer", "tags": [ "Trailers" ] }, "patch": { "description": "Update a trailer. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard.\n This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource.\n For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Trailers** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "updateTrailer", "parameters": [ { "description": "ID of the trailer. Can be either unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the trailer.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrailersUpdateTrailerBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Update a trailer", "tags": [ "Trailers" ], "x-codegen-request-body-name": "UpdateTrailerRequestBody" } }, "/fleet/vehicles": { "get": { "description": "Returns a list of all vehicles.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 25 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "listVehicles", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "default": 512, "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of attribute value IDs. Only entities associated with ALL of the referenced values will be returned (i.e. the intersection of the sets of entities with each value). Example: `attributeValueIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`", "in": "query", "name": "attributeValueIds", "schema": { "type": "string" } }, { "description": " A filter on data to have an updated at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "updatedAfterTime", "schema": { "type": "string" } }, { "description": " A filter on data to have a created at time after or equal to this specified time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "createdAfterTime", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesListVehiclesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "List all vehicles.", "tags": [ "Vehicles" ] } }, "/fleet/vehicles/driver-assignments": { "get": { "description": "**Note: This is a legacy endpoint, consider using [this endpoint](https://developers.samsara.com/reference/getdrivervehicleassignments) instead. The endpoint will continue to function as documented.** Get all driver assignments for the requested vehicles in the requested time range. The only type of assignment supported right now are assignments created through the driver app.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getVehiclesDriverAssignments", "parameters": [ { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). The maximum allowed startTime-endTime range is 7 days.", "in": "query", "name": "startTime", "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00). The maximum allowed startTime-endTime range is 7 days.", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "vehicleIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[legacy] Get all drivers assigned to a set of vehicles", "tags": [ "Legacy APIs" ] } }, "/fleet/vehicles/immobilizer/stream": { "get": { "description": "Get the engine immobilizer states of the queried vehicles. If a vehicle has never had an engine immobilizer connected, there won't be any state returned for that vehicle.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Vehicle Immobilization** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getEngineImmobilizerStates", "parameters": [ { "description": " A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "vehicleIds", "required": true, "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EngineImmobilizerGetEngineImmobilizerStatesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get engine immobilizer states", "tags": [ "Beta APIs" ] } }, "/fleet/vehicles/locations": { "get": { "description": "***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestats) instead.***\n\nReturns the last known location of all vehicles at the given `time`. If no `time` is specified, the current time is used. This can be optionally filtered by tags or specific vehicle IDs.\n\nRelated guide: \u003Ca href=\"/docs/vehicle-locations-1\" target=\"_blank\"\u003EVehicle Locations\u003C/a\u003E. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getVehicleLocations", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Example: `2020-01-27T07:06:25Z`).", "in": "query", "name": "time", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`", "explode": false, "in": "query", "name": "vehicleIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleLocationsResponse" } } }, "description": "List of the most recent locations for the specified vehicles." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Locations snapshot", "tags": [ "Vehicle Locations" ] } }, "/fleet/vehicles/locations/feed": { "get": { "description": "***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatsfeed) instead.***\n\nFollow a continuous feed of all vehicle locations from Samsara Vehicle Gateways.\n\nYour first call to this endpoint will provide you with the most recent location for each vehicle and a `pagination` object that contains an `endCursor`.\n\nYou can provide the `endCursor` to the `after` parameter of this endpoint to get location updates since that `endCursor`. \n\nIf `hasNextPage` is `false`, no updates are readily available yet. We'd suggest waiting a minimum of 5 seconds before requesting updates.\n\nRelated guide: \u003Ca href=\"/docs/vehicle-locations-1\" target=\"_blank\"\u003EVehicle Locations\u003C/a\u003E. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicle category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getVehicleLocationsFeed", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`", "explode": false, "in": "query", "name": "vehicleIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleLocationsListResponse" } } }, "description": "List of locations events for the specified vehicles." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Locations feed", "tags": [ "Vehicle Locations" ] } }, "/fleet/vehicles/locations/history": { "get": { "description": "***NOTE: The Vehicle Locations API is an older API that does not combine GPS data with onboard diagnostics. Try our new [Vehicle Stats API](ref:getvehiclestatshistory) instead.***\n\nReturns all known vehicle locations during the given time range. This can be optionally filtered by tags or specific vehicle IDs.\n\nRelated guide: \u003Ca href=\"/docs/vehicle-locations-1\" target=\"_blank\"\u003EVehicle Locations\u003C/a\u003E. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicle category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getVehicleLocationsHistory", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`", "explode": false, "in": "query", "name": "vehicleIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleLocationsListResponse" } } }, "description": "List of all locations for the specified vehicles and time range." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Historical locations", "tags": [ "Vehicle Locations" ] } }, "/fleet/vehicles/stats": { "get": { "description": "Returns the last known stats of all vehicles at the given `time`. If no `time` is specified, the current time is used.\n\nRelated guide: \u003Ca href=\"/docs/telematics\" target=\"_blank\"\u003ETelematics\u003C/a\u003E. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getVehicleStats", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data that returns the last known data points with timestamps less than or equal to this value. Defaults to now if not provided. Must be a string in RFC 3339 format. Millisecond precision and timezones are supported. (Example: `2020-01-27T07:06:25Z`).", "in": "query", "name": "time", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`", "explode": false, "in": "query", "name": "vehicleIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "The stat types you want this endpoint to return information on. See also the \u003Ca href=\"/docs/telematics#query-parameters\" target=\"_blank\"\u003ETelematics\u003C/a\u003E guide for more details.\n\nYou may list ***up to 3*** types using comma-separated format. For example: `types=gps,engineStates,obdOdometerMeters`.\n\n*Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3. For example, you could list `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3` and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still count as their own individual types.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary inputs\u003C/a\u003E for the vehicle.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use \u003Ca href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\"\u003EGet engine immobilizer states\u003C/a\u003E to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD odometer cannot be pulled automatically. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading\" target=\"_blank\"\u003Ecloud dasbhoard\u003C/a\u003E. Odometer readings that are manually set will update as GPS trip data is gathered. Try combining with `obdOdometerMeters`.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted. Try combining with `gpsOdometerMeters`. \n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast mode’.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)", "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "ambientAirTemperatureMilliC", "auxInput1", "auxInput2", "auxInput3", "auxInput4", "auxInput5", "auxInput6", "auxInput7", "auxInput8", "auxInput9", "auxInput10", "auxInput11", "auxInput12", "auxInput13", "barometricPressurePa", "batteryMilliVolts", "defLevelMilliPercent", "ecuSpeedMph", "engineCoolantTemperatureMilliC", "engineImmobilizer", "engineLoadPercent", "engineOilPressureKPa", "engineRpm", "engineStates", "faultCodes", "fuelPercents", "gps", "gpsDistanceMeters", "gpsOdometerMeters", "intakeManifoldTemperatureMilliC", "nfcCardScans", "obdEngineSeconds", "obdOdometerMeters", "syntheticEngineSeconds", "evStateOfChargeMilliPercent", "evChargingStatus", "evChargingEnergyMicroWh", "evChargingVoltageMilliVolt", "evChargingCurrentMilliAmp", "evConsumedEnergyMicroWh", "evRegeneratedEnergyMicroWh", "evBatteryVoltageMilliVolt", "evBatteryCurrentMilliAmp", "evBatteryStateOfHealthMilliPercent", "evAverageBatteryTemperatureMilliCelsius", "evDistanceDrivenMeters", "spreaderLiquidRate", "spreaderGranularRate", "spreaderPrewetRate", "spreaderAirTemp", "spreaderRoadTemp", "spreaderOnState", "spreaderActive", "spreaderBlastState", "spreaderGranularName", "spreaderPrewetName", "spreaderLiquidName", "spreaderPlowStatus", "seatbeltDriver" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleStatsResponse" } } }, "description": "Vehicle stats snapshot" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Stats snapshot", "tags": [ "Vehicle Stats" ] } }, "/fleet/vehicles/stats/feed": { "get": { "description": "Follow a feed of vehicle stats. \n\nYour first call to this endpoint will provide you with the most recent stats for each vehicle and an `endCursor`.\n\nYou can the provide the `endCursor` value to the `after` query parameter to get all updates since the last call you made.\n\nIf `hasNextPage` is `false`, no new data is immediately available. You should wait a minimum of 5 seconds making a subsequent request.\n\nRelated guide: \u003Ca href=\"/docs/telematics\" target=\"_blank\"\u003ETelematics\u003C/a\u003E. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getVehicleStatsFeed", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`", "explode": false, "in": "query", "name": "vehicleIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "The stat types you want this endpoint to return information on. See also the \u003Ca href=\"/docs/telematics#query-parameters\" target=\"_blank\"\u003ETelematics\u003C/a\u003E guide for more details.\n\nYou may list ***up to 3*** types using comma-separated format. For example: `types=gps,engineStates,obdOdometerMeters`.\n\n*Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3. For example, you could list `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3` and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still count as their own individual types.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary inputs\u003C/a\u003E for the vehicle.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use \u003Ca href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\"\u003EGet engine immobilizer states\u003C/a\u003E to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD odometer cannot be pulled automatically. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading\" target=\"_blank\"\u003Ecloud dasbhoard\u003C/a\u003E. Odometer readings that are manually set will update as GPS trip data is gathered. Try combining with `obdOdometerMeters`.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted. Try combining with `gpsOdometerMeters`. \n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast mode’.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)", "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "ambientAirTemperatureMilliC", "auxInput1", "auxInput2", "auxInput3", "auxInput4", "auxInput5", "auxInput6", "auxInput7", "auxInput8", "auxInput9", "auxInput10", "auxInput11", "auxInput12", "auxInput13", "barometricPressurePa", "batteryMilliVolts", "defLevelMilliPercent", "ecuSpeedMph", "engineCoolantTemperatureMilliC", "engineImmobilizer", "engineLoadPercent", "engineOilPressureKPa", "engineRpm", "engineStates", "faultCodes", "fuelPercents", "gps", "gpsDistanceMeters", "gpsOdometerMeters", "intakeManifoldTemperatureMilliC", "nfcCardScans", "obdEngineSeconds", "obdOdometerMeters", "syntheticEngineSeconds", "evStateOfChargeMilliPercent", "evChargingStatus", "evChargingEnergyMicroWh", "evChargingVoltageMilliVolt", "evChargingCurrentMilliAmp", "evConsumedEnergyMicroWh", "evRegeneratedEnergyMicroWh", "evBatteryVoltageMilliVolt", "evBatteryCurrentMilliAmp", "evBatteryStateOfHealthMilliPercent", "evAverageBatteryTemperatureMilliCelsius", "evDistanceDrivenMeters", "spreaderLiquidRate", "spreaderGranularRate", "spreaderPrewetRate", "spreaderAirTemp", "spreaderRoadTemp", "spreaderOnState", "spreaderActive", "spreaderBlastState", "spreaderGranularName", "spreaderPrewetName", "spreaderLiquidName", "spreaderPlowStatus", "seatbeltDriver" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Decorations to add to the primary stats listed in the `types` parameter. For example, if you wish to know the vehicle's location whenever the engine changes state, you may set `types=engineStates&decorations=gps`.\n\nYou may list ***up to 2*** decorations using comma-separated format. If multiple stats are listed in the `types` parameter, the decorations will be added to each one. For example: `types=engineStates,obdOdometerMeters,faultCodes&decorations=gps,fuelPercents` will list GPS and fuel decorations for each engine state change, each odometer reading, and each fault code. See the \u003Ca href=\"/docs/telematics#query-parameters\" target=\"_blank\"\u003ETelematics\u003C/a\u003E guide for more details.\n\nNote that decorations may significantly increase the response payload size.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary inputs\u003C/a\u003E for the vehicle.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use \u003Ca href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\"\u003EGet engine immobilizer states\u003C/a\u003E to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted.\n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast mode’.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)", "explode": false, "in": "query", "name": "decorations", "schema": { "items": { "enum": [ "ambientAirTemperatureMilliC", "auxInput1", "auxInput2", "auxInput3", "auxInput4", "auxInput5", "auxInput6", "auxInput7", "auxInput8", "auxInput9", "auxInput10", "auxInput11", "auxInput12", "auxInput13", "batteryMilliVolts", "barometricPressurePa", "defLevelMilliPercent", "ecuSpeedMph", "engineCoolantTemperatureMilliC", "engineImmobilizer", "engineLoadPercent", "engineOilPressureKPa", "engineRpm", "engineStates", "faultCodes", "fuelPercents", "gps", "gpsDistanceMeters", "intakeManifoldTemperatureMilliC", "nfcCardScans", "obdEngineSeconds", "obdOdometerMeters", "spreaderLiquidRate", "spreaderGranularRate", "spreaderPrewetRate", "spreaderAirTemp", "spreaderRoadTemp", "spreaderOnState", "spreaderActive", "spreaderBlastState", "spreaderGranularName", "spreaderPrewetName", "spreaderLiquidName", "spreaderPlowStatus", "seatbeltDriver" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleStatsListResponse" } } }, "description": "List of stat events for the specified vehicles and stat types." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Stats feed", "tags": [ "Vehicle Stats" ] } }, "/fleet/vehicles/stats/history": { "get": { "description": "Returns vehicle stats during the given time range for all vehicles. This can be optionally filtered by tags or specific vehicle IDs.\n\nRelated guide: \u003Ca href=\"/docs/telematics\" target=\"_blank\"\u003ETelematics\u003C/a\u003E. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Vehicle Statistics** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getVehicleStatsHistory", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`", "explode": false, "in": "query", "name": "vehicleIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "The stat types you want this endpoint to return information on. See also the \u003Ca href=\"/docs/telematics#query-parameters\" target=\"_blank\"\u003ETelematics\u003C/a\u003E guide for more details.\n\nYou may list ***up to 3*** types using comma-separated format. For example: `types=gps,engineStates,obdOdometerMeters`.\n\n*Note:* `auxInput3`-`auxInput10` count as a single type against the limit of 3. For example, you could list `types=engineStates,obdOdometerMeters,auxInput3,auxInput4` because `auxInput3` and `auxInput4` count as a single stat type. `auxInput1` and `auxInput2` still count as their own individual types.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary inputs\u003C/a\u003E for the vehicle.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `defLevelMilliPercent`: The Diesel Exhaust Fluid (DEF) level in milli percentage points (e.g. `99001`, `49999`, etc).\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use \u003Ca href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\"\u003EGet engine immobilizer states\u003C/a\u003E to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `gpsOdometerMeters`: Odometer reading provided by GPS calculations when OBD odometer cannot be pulled automatically. You must provide a manual odometer reading before this value is updated. Manual odometer readings can be provided via the [PATCH /fleet/vehicles/{id}](ref:updatevehicle) endpoint or through the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/115005273667-Editing-Odometer-Reading\" target=\"_blank\"\u003Ecloud dasbhoard\u003C/a\u003E. Odometer readings that are manually set will update as GPS trip data is gathered. Try combining with `obdOdometerMeters`.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted. Try combining with `gpsOdometerMeters`. \n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast mode’.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)", "explode": false, "in": "query", "name": "types", "required": true, "schema": { "items": { "enum": [ "ambientAirTemperatureMilliC", "auxInput1", "auxInput2", "auxInput3", "auxInput4", "auxInput5", "auxInput6", "auxInput7", "auxInput8", "auxInput9", "auxInput10", "auxInput11", "auxInput12", "auxInput13", "barometricPressurePa", "batteryMilliVolts", "defLevelMilliPercent", "ecuSpeedMph", "engineCoolantTemperatureMilliC", "engineImmobilizer", "engineLoadPercent", "engineOilPressureKPa", "engineRpm", "engineStates", "faultCodes", "fuelPercents", "gps", "gpsDistanceMeters", "gpsOdometerMeters", "intakeManifoldTemperatureMilliC", "nfcCardScans", "obdEngineSeconds", "obdOdometerMeters", "syntheticEngineSeconds", "evStateOfChargeMilliPercent", "evChargingStatus", "evChargingEnergyMicroWh", "evChargingVoltageMilliVolt", "evChargingCurrentMilliAmp", "evConsumedEnergyMicroWh", "evRegeneratedEnergyMicroWh", "evBatteryVoltageMilliVolt", "evBatteryCurrentMilliAmp", "evBatteryStateOfHealthMilliPercent", "evAverageBatteryTemperatureMilliCelsius", "evDistanceDrivenMeters", "spreaderLiquidRate", "spreaderGranularRate", "spreaderPrewetRate", "spreaderAirTemp", "spreaderRoadTemp", "spreaderOnState", "spreaderActive", "spreaderBlastState", "spreaderGranularName", "spreaderPrewetName", "spreaderLiquidName", "spreaderPlowStatus", "seatbeltDriver" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Decorations to add to the primary stats listed in the `types` parameter. For example, if you wish to know the vehicle's location whenever the engine changes state, you may set `types=engineStates&decorations=gps`.\n\nYou may list ***up to 2*** decorations using comma-separated format. If multiple stats are listed in the `types` parameter, the decorations will be added to each one. For example: `types=engineStates,obdOdometerMeters,faultCodes&decorations=gps,fuelPercents` will list GPS and fuel decorations for each engine state change, each odometer reading, and each fault code. See the \u003Ca href=\"/docs/telematics#query-parameters\" target=\"_blank\"\u003ETelematics\u003C/a\u003E guide for more details.\n\nNote that decorations may significantly increase the response payload size.\n\n- `ambientAirTemperatureMilliC`: The ambient air temperature reading in millidegree Celsius.\n- `auxInput1`-`auxInput13`: Stat events from the \u003Ca href=\"https://kb.samsara.com/hc/en-us/articles/360043040512-Auxiliary-Inputs\" target=\"_blank\"\u003Eauxiliary inputs\u003C/a\u003E for the vehicle.\n- `batteryMilliVolts`: The vehicle battery voltage reading.\n- `barometricPressurePa`: The barometric pressure reading in pascals.\n- `ecuSpeedMph`: The speed of the engine in miles per hour according to the ECU.\n- `engineCoolantTemperatureMilliC`: The engine coolant temperature reading in millidegree Celsius.\n- `engineImmobilizer`: The state of the engine immobilizer - Valid values: `ignition_disabled`, `ignition_enabled`. This stat type will only return states of our first Engine Immobilizer Hardware (ACC-EI). Please use \u003Ca href=\"https://developers.samsara.com/reference/getengineimmobilizerstates\" target=\"_blank\"\u003EGet engine immobilizer states\u003C/a\u003E to get states for both Engine Immobilizer Hardware versions (incl. HW-EI21).\n- `engineOilPressureKPa`: The engine oil pressure reading in kilopascals.\n- `engineLoadPercent`: The engine load in percentage points (e.g. `99`, `50`, etc).\n- `engineRpm`: The revolutions per minute of the engine.\n- `engineStates`: The state of the engine (`Off`, `On`, `Idle`).\n- `faultCodes`: The diagnostic fault codes for the vehicle.\n- `fuelPercents`: The engine fuel level in percentage points (e.g. `99`, `50`, etc).\n- `gps`: GPS data including lat/long, heading, speed, address book entry (if exists), and a reverse geocoded address.\n- `gpsDistanceMeters`: The distance the vehicle has traveled since the gateway was installed based on GPS calculations.\n- `intakeManifoldTemperatureMilliC`: The intake manifold temperature reading in millidegree Celsius.\n- `nfcCardScans`: ID card scans.\n- `obdEngineSeconds`: The cumulative number of seconds the engine has run according to onboard diagnostics.\n- `obdOdometerMeters`: The odometer reading according to onboard diagnostics. If Samsara does not have diagnostic coverage for a particular vehicle, the value for this stat type will be omitted.\n- `syntheticEngineSeconds`: Data for the synthetic engine seconds for the vehicle.\n- `evStateOfChargeMilliPercent`: Milli percent State of Charge for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evChargingStatus`: Charging status for electric and hybrid vehicles. Not all EV and HEVs may report this field. Statuses: unknown - 0, not charging - 1, charging - 2.\n- `evChargingEnergyMicroWh`: Charging energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evChargingVoltageMilliVolt`: Charging voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evChargingCurrentMilliAmp`: Charging current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evConsumedEnergyMicroWh`: Consumed energy (including regenerated) for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evRegeneratedEnergyMicroWh`: Regenerated energy for electric and hybrid vehicles in microwatt hours. Not all EV and HEVs may report this field.\n- `evBatteryVoltageMilliVolt`: Battery voltage for electric and hybrid vehicles in milli volts. Not all EV and HEVs may report this field.\n- `evBatteryCurrentMilliAmp`: Battery current for electric and hybrid vehicles in milli amps. Not all EV and HEVs may report this field.\n- `evBatteryStateOfHealthMilliPercent`: Milli percent battery state of health for electric and hybrid vehicles. Not all EV and HEVs may report this field.\n- `evAverageBatteryTemperatureMilliCelsius`: Battery temperature for electric and hybrid vehicles in milli celsius. Not all EV and HEVs may report this field.\n- `evDistanceDrivenMeters`: Electric distance driven for electric and hybrid vehicles in meters. Not all EV and HEVs may report this field.\n- `spreaderLiquidRate`: Liquid spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderGranularRate`: Granular spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderPrewetRate`: Prewet spread rate reading in milliliters per meter, read from the material spreader. Unfiltered live stats are supplied as-read from the Material Spreader unit. Readings do not consider total spread rate(s) over time or distance.\n- `spreaderAirTemp`: Air (ambient) temperature in milli celsius reading from material spreader.\n- `spreaderRoadTemp`: Road temperature reading in milli celsius from material spreader.\n- `spreaderOnState`: Whether vehicle spreader is enabled.\n- `spreaderActive`: Whether vehicle is actively spreading any material.\n- `spreaderBlastState`: Whether vehicle is actively spreading material in ‘blast mode’.\n- `spreaderGranularName`: Name of most recent type of granular material spread, read from the material spreader.\n- `spreaderPrewetName`: Name of most recent type of prewet material spread, read from the material spreader.\n- `spreaderLiquidName`: Name of most recent type of liquid material spread, read from the material spreader.\n- `spreaderPlowStatus`: Snow plow status (`Up` or `Down`), as read from the material spreader. Note: this is separate from plow status defined via auxInput.\n- `seatbeltDriver`: Seatbelt Driver Status as read from the vehicle. `Buckled` or `Unbuckled`. (Beta only)", "explode": false, "in": "query", "name": "decorations", "schema": { "items": { "enum": [ "ambientAirTemperatureMilliC", "auxInput1", "auxInput2", "auxInput3", "auxInput4", "auxInput5", "auxInput6", "auxInput7", "auxInput8", "auxInput9", "auxInput10", "auxInput11", "auxInput12", "auxInput13", "batteryMilliVolts", "barometricPressurePa", "defLevelMilliPercent", "ecuSpeedMph", "engineCoolantTemperatureMilliC", "engineImmobilizer", "engineLoadPercent", "engineOilPressureKPa", "engineRpm", "engineStates", "faultCodes", "fuelPercents", "gps", "gpsDistanceMeters", "intakeManifoldTemperatureMilliC", "nfcCardScans", "obdEngineSeconds", "obdOdometerMeters", "spreaderLiquidRate", "spreaderGranularRate", "spreaderPrewetRate", "spreaderAirTemp", "spreaderRoadTemp", "spreaderOnState", "spreaderActive", "spreaderBlastState", "spreaderGranularName", "spreaderPrewetName", "spreaderLiquidName", "spreaderPlowStatus", "seatbeltDriver" ], "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleStatsListResponse" } } }, "description": "List of vehicle stats for the specified vehicles, stat type, and time range." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Historical stats", "tags": [ "Vehicle Stats" ] } }, "/fleet/vehicles/tachograph-files/history": { "get": { "description": "Returns all known tachograph files for all specified vehicles in the time range. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 150 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Tachograph (EU)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getVehicleTachographFiles", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of vehicle IDs. Example: `vehicleIds=1234,5678`", "explode": false, "in": "query", "name": "vehicleIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TachographVehicleFilesResponse" } } }, "description": "List of all vehicle tachograph files in a specified time range." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get tachograph vehicle files", "tags": [ "Tachograph (EU Only)" ] } }, "/fleet/vehicles/{id}": { "get": { "description": "Get information about a specific vehicle. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Vehicles** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getVehicle", "parameters": [ { "description": "ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleResponse" } } }, "description": "Returns the specified vehicle object." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Retrieve a vehicle", "tags": [ "Vehicles" ] }, "patch": { "description": "Updates the given Vehicle object.\n\n**Note:** Vehicle objects are automatically created when Samsara Vehicle Gateways are installed. You cannot create a Vehicle object via API.\n\nYou are able to *update* many of the fields of a Vehicle.\n\n**Note**: There are no required fields in the request body, and you only need to provide the fields you wish to update. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Vehicles** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "updateVehicle", "parameters": [ { "description": "ID of the vehicle. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource, or automatically populated by fields on the vehicle. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `maintenanceId:250020`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.vin:1HGBH41JXMN109186`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVehicleRequest" } } }, "description": "Fields that can be patched on a vehicle.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VehicleResponse" } } }, "description": "Returns the specified vehicle object." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update a vehicle", "tags": [ "Vehicles" ], "x-codegen-request-body-name": "vehicle" } }, "/form-submissions": { "get": { "description": "Returns all form submissions data for the specified IDs. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getFormSubmissions", "parameters": [ { "description": "A comma-separated list containing up to 100 form submission IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the form submission.", "explode": false, "in": "query", "name": "ids", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`", "explode": false, "in": "query", "name": "include", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get a list of specified form submissions.", "tags": [ "Beta APIs" ] }, "patch": { "description": "Updates an instance of a form submission. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchFormSubmission", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPatchFormSubmissionBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Update a single form submission.", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "PatchFormSubmissionRequestBody" }, "post": { "description": "Creates a form submission. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postFormSubmission", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Create a form submission.", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "PostFormSubmissionRequestBody" } }, "/form-submissions/pdf-exports": { "get": { "description": "Returns a PDF export for a form submission. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getFormSubmissionsPdfExports", "parameters": [ { "description": "ID of the form submission PDF export.", "in": "query", "name": "pdfId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsPdfExportsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Return a PDF export for a form submission.", "tags": [ "Beta APIs" ] }, "post": { "description": "Creates a PDF export for a form submission. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Form Submissions** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postFormSubmissionsPdfExports", "parameters": [ { "description": "ID of the form submission to create a PDF export from.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsResponseBody" } } }, "description": "Accepted response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsPostFormSubmissionsPdfExportsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Create a PDF export for a form submission.", "tags": [ "Beta APIs" ] } }, "/form-submissions/stream": { "get": { "description": "Returns all form submissions data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Form Submissions** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getFormSubmissionsStream", "parameters": [ { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A comma-separated list containing up to 50 template IDs to filter data to.", "explode": false, "in": "query", "name": "formTemplateIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list containing up to 50 user IDs to filter data to.", "explode": false, "in": "query", "name": "userIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list containing up to 50 user IDs to filter data to.", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of strings indicating whether to return additional information. Valid values: `externalIds`, `fieldLabels`", "explode": false, "in": "query", "name": "include", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list containing up to 50 route stop IDs to filter data to.", "explode": false, "in": "query", "name": "assignedToRouteStopIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormSubmissionsGetFormSubmissionsStreamBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get a stream of filtered form submissions.", "tags": [ "Beta APIs" ] } }, "/fuel-purchase": { "post": { "description": "Create a fuel purchase transaction.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Fuel Purchase** under the Fuel & Energy category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postFuelPurchase", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FuelPurchasePostFuelPurchaseBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Create a fuel purchase transaction.", "tags": [ "Fuel and Energy" ], "x-codegen-request-body-name": "PostFuelPurchaseRequestBody" } }, "/gateways": { "get": { "description": "List all gateways\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Gateways** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getGateways", "parameters": [ { "description": "Filter by a comma separated list of gateway models.", "explode": false, "in": "query", "name": "models", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysGetGatewaysBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "List all gateways", "tags": [ "Gateways" ] }, "post": { "description": "Activate a new gateway. To activate a device and associate it with your organization, enter its serial number. Each device's serial number can also be found on its label or packaging, or from your order confirmation email. A Not Found error could mean that the serial was not found or it has already been activated\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Gateways** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postGateway", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysPostGatewayBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Activate a new gateway", "tags": [ "Gateways" ], "x-codegen-request-body-name": "PostGatewayRequestBody" } }, "/gateways/{id}": { "delete": { "description": "Deactivate a gateway\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Gateways** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteGateway", "parameters": [ { "description": "Gateway serial number", "in": "path", "name": "id", "required": true, "schema": { "pattern": "^[a-zA-Z0-9]{4}-[a-zA-Z0-9]{3}-[a-zA-Z0-9]{3}$", "type": "string" } } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GatewaysDeleteGatewayBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Deactivate a gateway", "tags": [ "Gateways" ] } }, "/hos/daily-logs/log-meta-data": { "patch": { "description": "Update the shippingDocs field of an existing assignment.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write ELD Hours of Service (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "updateShippingDocs", "parameters": [ { "description": "A start date in yyyy-mm-dd format. Required.", "in": "query", "name": "hosDate", "required": true, "schema": { "type": "string" } }, { "description": "ID of the driver for whom the duty status is being set.", "in": "query", "name": "driverID", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HosDailyLogsUpdateShippingDocsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Update the shippingDocs field of an existing assignment.", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "UpdateShippingDocsRequestBody" } }, "/ifta-detail/csv": { "post": { "description": "Create a job to generate csv files of IFTA mileage segments.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write IFTA (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "createIftaDetailJob", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobRequestBody" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobResponseBody" } } }, "description": "Created response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTACreateIftaDetailJobBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Create a job to generate csv files of IFTA mileage segments.", "tags": [ "IFTA" ], "x-codegen-request-body-name": "CreateIftaDetailJobRequestBody" } }, "/ifta-detail/csv/{id}": { "get": { "description": "Get information about an existing IFTA detail job.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read IFTA (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getIftaDetailJob", "parameters": [ { "description": "ID of the requested job.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IFTAGetIftaDetailJobBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get information about an existing IFTA detail job.", "tags": [ "IFTA" ] } }, "/industrial/assets": { "get": { "description": "List all assets in the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getIndustrialAssets", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`", "explode": false, "in": "query", "name": "assetIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListIndustrialAssetsResponse" } } }, "description": "Assets in the organization." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all assets", "tags": [ "Industrial" ] }, "post": { "description": "Create an asset with optional configuration parameters. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "createIndustrialAsset", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetCreate" } } }, "description": "The asset to create", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200" } } }, "description": "Newly created asset object" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Create an asset", "tags": [ "Industrial" ], "x-codegen-request-body-name": "asset" } }, "/industrial/assets/{id}": { "delete": { "description": "Delete asset. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "deleteIndustrialAsset", "parameters": [ { "description": "Id of the asset to be deleted.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardDeleteResponse" } } }, "description": "A successful DELETE response is a 204 with no content." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Delete an existing asset", "tags": [ "Industrial" ] }, "patch": { "description": "Update an existing asset. Only the provided fields will be updated. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Equipment** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "patchIndustrialAsset", "parameters": [ { "description": "Id of the asset to be updated", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetPatch" } } }, "description": "The updated asset fields", "required": false }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200" } } }, "description": "The updated asset" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update an asset", "tags": [ "Industrial" ], "x-codegen-request-body-name": "asset" } }, "/industrial/assets/{id}/data-outputs": { "patch": { "description": "Writes values to multiple data outputs on an asset simultaneously. Only the provided data outputs will be updated.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchAssetDataOutputs", "parameters": [ { "description": "Asset ID", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetDataOutputsPatchAssetDataOutputsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Writes to data outputs on an asset", "tags": [ "Industrial" ], "x-codegen-request-body-name": "PatchAssetDataOutputsRequestBody" } }, "/industrial/data-inputs": { "get": { "description": "Returns all data inputs, optionally filtered by tags or asset ids. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDataInputs", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`", "explode": false, "in": "query", "name": "assetIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataInputsTinyResponse" } } }, "description": "List of data inputs with names, ids, and other metadata." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List all data inputs", "tags": [ "Industrial" ] } }, "/industrial/data-inputs/data-points": { "get": { "description": "Returns last known data points for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDataInputDataSnapshot", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`", "explode": false, "in": "query", "name": "dataInputIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`", "explode": false, "in": "query", "name": "assetIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataInputSnapshotResponse" } } }, "description": "List of last known data input data points and pagination parameters" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List most recent data points for data inputs", "tags": [ "Industrial" ] } }, "/industrial/data-inputs/data-points/feed": { "get": { "description": "Follow a continuous feed of all data input data points.\n\nYour first call to this endpoint will provide you with the most recent data points for each data input and a `pagination` object that contains an `endCursor`.\n\nYou can provide the `endCursor` to the `after` parameter of this endpoint to get data point updates since that `endCursor`.\n\nIf `hasNextPage` is `false`, no updates are readily available yet. We suggest waiting a minimum of 5 seconds before requesting updates. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDataInputDataFeed", "parameters": [ { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`", "explode": false, "in": "query", "name": "dataInputIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`", "explode": false, "in": "query", "name": "assetIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataInputListResponse" } } }, "description": "List of all data points for specified data inputs" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Follow a real-time feed of data points for data inputs", "tags": [ "Industrial" ] } }, "/industrial/data-inputs/data-points/history": { "get": { "description": "Returns all known data points during the given time range for all data inputs. This can be filtered by optional tags, specific data input IDs or asset IDs. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getDataInputDataHistory", "parameters": [ { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "explode": false, "in": "query", "name": "parentTagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "explode": false, "in": "query", "name": "tagIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of data input IDs. Example: `dataInputIds=1234,5678`", "explode": false, "in": "query", "name": "dataInputIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of industrial asset UUIDs. Example: `assetIds=076efac2-83b5-47aa-ba36-18428436dcac,6707b3f0-23b9-4fe3-b7be-11be34aea544`", "explode": false, "in": "query", "name": "assetIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataInputListResponse" } } }, "description": "List of all data points for the specified data inputs and time range." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List historical data points for data inputs", "tags": [ "Industrial" ] } }, "/issues": { "get": { "description": "Returns all issues data for the specified IDs. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Issues** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getIssues", "parameters": [ { "description": "A comma-separated list containing up to 100 issue IDs to filter on. Can be either a unique Samsara ID or an [external ID](https://developers.samsara.com/docs/external-ids) for the issue.", "explode": false, "in": "query", "name": "ids", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma separated list of additional fields to include on requested objects. Valid values: `externalIds`", "explode": false, "in": "query", "name": "include", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get a list of specified issues.", "tags": [ "Beta APIs" ] }, "patch": { "description": "Updates an instance of an issue. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Issues** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchIssue", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesPatchIssueBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Update a single issue.", "tags": [ "Beta APIs" ], "x-codegen-request-body-name": "PatchIssueRequestBody" } }, "/issues/stream": { "get": { "description": "Returns all issues data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you don’t include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Forms APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Issues** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getIssuesStream", "parameters": [ { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A comma-separated list containing status values to filter issues on. Valid values: `open`, `inProgress`, `resolved`, `dismissed`", "explode": false, "in": "query", "name": "status", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list containing up to 50 asset IDs to filter issues on. Issues with untracked assets can also be included by passing the value: 'untracked'.", "explode": false, "in": "query", "name": "assetIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma separated list of additional fields to include on requested objects. Valid values: `externalIds`", "explode": false, "in": "query", "name": "include", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuesGetIssuesStreamBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get a stream of filtered issues.", "tags": [ "Beta APIs" ] } }, "/live-shares": { "delete": { "description": "Delete Live Sharing Link.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Live Sharing Links** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteLiveSharingLink", "parameters": [ { "description": "Unique identifier for the Live Sharing Link.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksDeleteLiveSharingLinkBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Delete non-expired Live Sharing Link", "tags": [ "Live Sharing Links" ] }, "get": { "description": "Returns all non-expired Live Sharing Links.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Live Sharing Links** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getLiveSharingLinks", "parameters": [ { "description": "A filter on the data based on this comma-separated list of Live Share Link IDs", "explode": false, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A filter on the data based on the Live Sharing Link type. Valid values: `all`, `assetsLocation`, `assetsNearLocation`, `assetsOnRoute`", "in": "query", "name": "type", "schema": { "default": "all", "enum": [ "all", "assetsLocation", "assetsNearLocation", "assetsOnRoute" ], "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 100 objects.", "in": "query", "name": "limit", "schema": { "default": 100, "maximum": 100, "minimum": 1, "type": "integer" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksGetLiveSharingLinksBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Get Live Sharing Links", "tags": [ "Live Sharing Links" ] }, "patch": { "description": "Update Live Sharing Link.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Live Sharing Links** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "updateLiveSharingLink", "parameters": [ { "description": "Unique identifier for the Live Sharing Link.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksUpdateLiveSharingLinkBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Update non-expired Live Sharing Link", "tags": [ "Live Sharing Links" ], "x-codegen-request-body-name": "UpdateLiveSharingLinkRequestBody" }, "post": { "description": "Create Live Sharing Link.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Live Sharing Links** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "createLiveSharingLink", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveSharingLinksCreateLiveSharingLinkBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Create Live Sharing Link", "tags": [ "Live Sharing Links" ], "x-codegen-request-body-name": "CreateLiveSharingLinkRequestBody" } }, "/me": { "get": { "description": "Get information about your organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Org Information** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getOrganizationInfo", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationInfoResponse" } } }, "description": "Returns information about your organization." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Get information about your organization", "tags": [ "Organization Info" ] } }, "/preview/custom-reports/configs": { "get": { "description": "Get paginated custom report configs created in the organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getCustomReportConfigs", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "The limit for how many reports will be in the response. Default and max for this value is 100 objects.", "in": "query", "name": "limit", "schema": { "default": 100, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportConfigsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Get custom report configs", "tags": [ "Preview APIs" ] } }, "/preview/custom-reports/runs": { "get": { "description": "Get all custom report runs with the provided IDs or customReportIds.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getCustomReportRuns", "parameters": [ { "description": "Required array of custom report IDs for the custom report runs wanted. Only one of customReportIds or ids is allowed.", "explode": false, "in": "query", "name": "customReportIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Required array of custom report run IDs to fetch. Only one of ids or customReportIds is allowed.", "explode": false, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Get custom report runs", "tags": [ "Preview APIs" ] }, "post": { "description": "Create a custom report run which then gets queued up to generate custom report data for the report run.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 240 requests/day (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Custom Reports** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postCustomReportRun", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsPostCustomReportRunBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Create a custom report run", "tags": [ "Preview APIs" ], "x-codegen-request-body-name": "PostCustomReportRunRequestBody" } }, "/preview/custom-reports/runs/data": { "get": { "description": "This endpoint will return the custom report data for a given custom report run ID. For more information regarding custom report columns, please see our [KB article section on Custom Report Fields](https://kb.samsara.com/hc/en-us/articles/360052711232-Manage-Custom-Reports).\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Custom Reports** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getCustomReportRunData", "parameters": [ { "description": "The ID of the specified run for the requested custom report.", "in": "query", "name": "id", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomReportsGetCustomReportRunDataBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Get custom report run data", "tags": [ "Preview APIs" ] } }, "/preview/driver-efficiency/drivers": { "get": { "description": "This endpoint will return driver efficiency data that has been collected for your organization and grouped by drivers based on the time parameters passed in. Results are paginated.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDriverEfficiencyByDrivers", "parameters": [ { "description": "A start time in RFC 3339 format. Must be in multiple of hours and at least 1 day before endTime. Timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-11T19:00:00Z, 2015-09-12T14:00:00-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Must be in multiple of hours and no later than 3 hours before the current time. Timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-13T19:00:00Z, 2015-09-15T14:00:00-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of driver IDs and externalIds. Example: `driverIds=1234,5678,payroll:4841`", "explode": false, "in": "query", "name": "driverIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "A comma-separated list of data formats you want to fetch. Valid values: `score`, `raw` and `percentage`. The default data format is `score`. Example: `dataFormats=raw,score`", "explode": false, "in": "query", "name": "dataFormats", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByDriversBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Get Driver efficiency data grouped by drivers.", "tags": [ "Preview APIs" ] } }, "/preview/driver-efficiency/vehicles": { "get": { "description": "This endpoint will return driver efficiency data that has been collected for your organization and grouped by vehicle drivers used based on the time parameters passed in. Results are paginated.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Driver Efficiency** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getDriverEfficiencyByVehicles", "parameters": [ { "description": "A start time in RFC 3339 format. Must be in multiple of hours and at least 1 day before endTime. Timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-11T19:00:00Z, 2015-09-12T14:00:00-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "An end time in RFC 3339 format. Must be in multiple of hours and no later than 3 hours before the current time. Timezones are supported. Note that the most recent 72 hours of data may still be processing and is subject to change and latency, so it is not recommended to request data for the most recent 72 hours. (Examples: 2019-06-13T19:00:00Z, 2015-09-15T14:00:00-04:00).", "in": "query", "name": "endTime", "required": true, "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of vehicle IDs and externalIds. Example: `vehicleIds=1234,5678,samsara.vin:1HGBH41JXMN109186`", "in": "query", "name": "vehicleIds", "schema": { "type": "string" } }, { "description": "A comma-separated list of data formats you want to fetch. Valid values: `score`, `raw` and `percentage`. The default data format is `score`. Example: `dataFormats=raw,score`", "explode": false, "in": "query", "name": "dataFormats", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " A filter on the data based on this comma-separated list of tag IDs. Example: `tagIds=1234,5678`", "in": "query", "name": "tagIds", "schema": { "type": "string" } }, { "description": " A filter on the data based on this comma-separated list of parent tag IDs, for use by orgs with tag hierarchies. Specifying a parent tag will implicitly include all descendent tags of the parent tag. Example: `parentTagIds=345,678`", "in": "query", "name": "parentTagIds", "schema": { "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverEfficiencyGetDriverEfficiencyByVehiclesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Get Driver efficiency data grouped by vehicles.", "tags": [ "Preview APIs" ] } }, "/preview/form-templates": { "get": { "description": "Returns a list of the organization's form templates.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Preview** under the category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getFormTemplates", "parameters": [ { "description": "A comma-separated list containing up to 100 template IDs to filter on.", "explode": false, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FormTemplatesGetFormTemplatesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Get a list of form templates.", "tags": [ "Preview APIs" ] } }, "/preview/maintenance/service-tasks": { "get": { "description": "Gets service tasks.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getServiceTasks", "parameters": [ { "description": "Filter by the IDs. If not provided, won't filter by id.", "explode": true, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Include archived service task definitions.", "in": "query", "name": "includeArchived", "schema": { "type": "boolean" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetServiceTasksBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Gets service tasks.", "tags": [ "Preview APIs" ] } }, "/preview/maintenance/work-orders": { "delete": { "description": "Deletes a work order.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteWorkOrders", "parameters": [ { "description": "The unique id of the work order.", "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersDeleteWorkOrdersBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Deletes a work order.", "tags": [ "Preview APIs" ] }, "get": { "description": "Gets work orders.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getWorkOrders", "parameters": [ { "description": "Filter by the IDs. Up to 100 ids. Returns all if no ids are provided.", "explode": true, "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersGetWorkOrdersBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Gets work orders.", "tags": [ "Preview APIs" ] }, "patch": { "description": "Updates a work order.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchWorkOrders", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPatchWorkOrdersBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Updates a work order.", "tags": [ "Preview APIs" ], "x-codegen-request-body-name": "PatchWorkOrdersRequestBody" }, "post": { "description": "Creates a work order.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Work Orders** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postWorkOrders", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersPostWorkOrdersBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Creates a work order.", "tags": [ "Preview APIs" ], "x-codegen-request-body-name": "PostWorkOrdersRequestBody" } }, "/preview/maintenance/work-orders/stream": { "get": { "description": "Stream work orders.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Work Orders** under the Closed Beta category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n\nEndpoints in this section are in Preview. These APIs are not functional and are instead for soliciting feedback from our API users on the intended design of this API. Additionally, it is not guaranteed that we will be releasing an endpoint included in this section to production. This means that developers should **NOT** rely on these APIs to build business critical applications\n\n- Samsara may change the structure of a preview API's interface without versioning or any notice to API users.\n\n- When an endpoint becomes generally available, it will be announced in the API [changelog](https://developers.samsara.com/changelog).\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "streamWorkOrders", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "A start time in RFC 3339 format. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": "Work Order status filter.", "explode": true, "in": "query", "name": "workOrderStatuses", "schema": { "items": { "enum": [ "ASSIGNED", "CANCELLED", "CLOSED", "COMPLETED", "IN_PROGRESS", "ON_HOLD", "OPEN", "PENDING_APPROVAL", "PENDING_PARTS" ], "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Work Order asset id filter. Up to 50 ids.", "explode": true, "in": "query", "name": "assetIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Work Order assigned user id filter. Up to 50 ids.", "explode": true, "in": "query", "name": "assignedUserIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkOrdersStreamWorkOrdersBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[preview] Stream work orders.", "tags": [ "Preview APIs" ] } }, "/speeding-intervals/stream": { "get": { "description": "This endpoint will return all speeding intervals associated with trips that have been collected for your organization based on the time parameters passed in. Only completed trips are included. Results are paginated.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Speeding Intervals** under the Speeding Intervals category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getSpeedingIntervals", "parameters": [ { "description": "Comma-separated list of asset IDs. Include up to 50 asset IDs.", "explode": false, "in": "query", "name": "assetIds", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "RFC 3339 timestamp that indicates when to begin receiving data. Value is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter.", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "RFC 3339 timestamp which is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter. If not provided then the endpoint behaves as an unending feed of changes.", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": "Decide which timestamp the `startTime` and `endTime` are compared to. Valid values: `updatedAtTime`, `tripStartTime`", "in": "query", "name": "queryBy", "schema": { "default": "updatedAtTime", "enum": [ "updatedAtTime", "tripStartTime" ], "type": "string" } }, { "description": "Indicates whether or not to return expanded “asset” data", "in": "query", "name": "includeAsset", "schema": { "default": false, "type": "boolean" } }, { "description": "Indicates whether or not to return trip's driver id", "in": "query", "name": "includeDriverId", "schema": { "default": false, "type": "boolean" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Optional string of comma-separated severity levels to filter speeding intervals by. Valid values: “light”, ”moderate”, ”heavy”, “severe”.", "explode": false, "in": "query", "name": "severityLevels", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeedingIntervalsGetSpeedingIntervalsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get Speeding Intervals", "tags": [ "Beta APIs" ] } }, "/tags": { "get": { "description": "Return all of the tags for an organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Tags** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "listTags", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTagsResponse" } } }, "description": "List of tags." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all tags", "tags": [ "Tags" ] }, "post": { "description": "Create a new tag for the organization. This may include up to 20,000 tagged entities. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Tags** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "createTag", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTagRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } }, "description": "Newly created tag object, including the new tag ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Create a tag", "tags": [ "Tags" ], "x-codegen-request-body-name": "tag" } }, "/tags/{id}": { "delete": { "description": "Permanently deletes a tag. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Tags** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "deleteTag", "parameters": [ { "description": "ID of the Tag. This can either be the Samsara-provided ID or an external ID. External IDs are customer-specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `crmId:abc123`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.name:ELD-exempt`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardDeleteResponse" } } }, "description": "A successful DELETE response is a 204 with no content." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Delete a tag", "tags": [ "Tags" ] }, "get": { "description": "Fetch a tag by id. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Tags** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getTag", "parameters": [ { "description": "ID of the Tag. This can either be the Samsara-provided ID or an external ID. External IDs are customer-specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `crmId:abc123`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.name:ELD-exempt`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } }, "description": "The tag corresponding to request id." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Retrieve a tag", "tags": [ "Tags" ] }, "patch": { "description": "Update an existing tag. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard. \n\n This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource. \n\n For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Tags** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "patchTag", "parameters": [ { "description": "ID of the Tag. This can either be the Samsara-provided ID or an external ID. External IDs are customer-specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `crmId:abc123`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.name:ELD-exempt`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatchTagRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } }, "description": "Returns updated tag object." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update a tag", "tags": [ "Tags" ], "x-codegen-request-body-name": "tag" }, "put": { "description": "Update a tag with a new name and new members. This API call would replace all old members of a tag with new members specified in the request body. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Tags** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "replaceTag", "parameters": [ { "description": "ID of the Tag. This can either be the Samsara-provided ID or an external ID. External IDs are customer-specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `crmId:abc123`. Automatically populated external IDs are prefixed with `samsara.`. For example, `samsara.name:ELD-exempt`.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceTagRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TagResponse" } } }, "description": "The updated tag data." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update a tag", "tags": [ "Tags" ], "x-codegen-request-body-name": "tag" } }, "/training-assignments": { "delete": { "description": "This endpoint supports batch deletion operations. The response does not indicate which specific deletions, if any, have failed. On a successful deletion or partial failure, a ‘204 No Content’ status is returned. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Training Assignments** under the Training Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteTrainingAssignments", "parameters": [ { "description": "String of comma separated assignments IDs. Max value for this value is 100 objects .Example: `ids=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`", "explode": false, "in": "query", "name": "ids", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsDeleteTrainingAssignmentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Delete training assignments.", "tags": [ "Beta APIs" ] }, "patch": { "description": "Update training assignments. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Training Assignments** under the Training Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchTrainingAssignments", "parameters": [ { "description": "String of comma separated assignments IDs. Max value for this value is 100 objects .Example: `ids=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`", "explode": false, "in": "query", "name": "ids", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Due date of the training assignment in RFC 3339 format. Millisecond precision and timezones are supported.", "in": "query", "name": "dueAtTime", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPatchTrainingAssignmentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Update training assignments.", "tags": [ "Beta APIs" ] }, "post": { "description": "Create training assignments. Existing assignments will remain unchanged. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 10 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Training Assignments** under the Training Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postTrainingAssignments", "parameters": [ { "description": "String for the course ID.", "in": "query", "name": "courseId", "required": true, "schema": { "type": "string" } }, { "description": "Due date of the training assignment in RFC 3339 format. Millisecond precision and timezones are supported.", "in": "query", "name": "dueAtTime", "required": true, "schema": { "type": "string" } }, { "description": "Optional string of comma separated learner IDs. If learner ID is present, training assignments for the specified learner(s) will be returned. Max value for this value is 100 objects. Example: `learnerIds=driver-281474,driver-46282156`", "explode": false, "in": "query", "name": "learnerIds", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsPostTrainingAssignmentsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Create training assignments.", "tags": [ "Beta APIs" ] } }, "/training-assignments/stream": { "get": { "description": "Returns all training assignments data that has been created or modified for your organization based on the time parameters passed in. Results are paginated and are sorted by last modified date. If you include an endTime, the endpoint will return data up until that point (exclusive). If you don't include an endTime, you can continue to poll the API real-time with the pagination cursor that gets returned on every call. \n\n**Beta:** This endpoint is in beta and is likely to change before being broadly available. Reach out to your Samsara Representative to have Training APIs enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Training Assignments** under the Training Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getTrainingAssignmentsStream", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": " A start time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": " An end time in RFC 3339 format. Defaults to now if not provided. Millisecond precision and timezones are supported. (Examples: 2019-06-13T19:08:25Z, 2019-06-13T19:08:25.455Z, OR 2015-09-15T14:00:12-04:00).", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": "Optional string of comma separated learner IDs. If learner ID is present, training assignments for the specified learner(s) will be returned. Max value for this value is 100 objects. Example: `learnerIds=driver-281474,driver-46282156`", "explode": false, "in": "query", "name": "learnerIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional string of comma separated course IDs. If course ID is present, training assignments for the specified course ID(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `courseIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`", "explode": false, "in": "query", "name": "courseIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional string of comma separated values. If status is present, training assignments for the specified status(s) will be returned. Valid values: \"notStarted\", \"inProgress\", \"completed\". Defaults to returning all courses.", "explode": false, "in": "query", "name": "status", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingAssignmentsGetTrainingAssignmentsStreamBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get a stream of filtered training assignments.", "tags": [ "Beta APIs" ] } }, "/training-courses": { "get": { "description": "Returns all training courses data. Results are paginated. \n Courses in the ‘draft’ status are excluded from the data returned by this endpoint.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Training Courses** under the Training Courses category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getTrainingCourses", "parameters": [ { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Optional string of comma separated course IDs. If course ID is present, training assignments for the specified course ID(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `courseIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`", "explode": false, "in": "query", "name": "courseIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional string of comma separated course category IDs. If courseCategoryId is present, training courses for the specified course category(s) will be returned. Max value for this value is 100 objects. Defaults to returning all courses. Example: `categoryIds=a4db8702-79d5-4396-a717-e301d52ecc11,c6490f6a-d84e-49b5-b0ad-b6baae304075`", "explode": false, "in": "query", "name": "categoryIds", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" }, { "description": "Optional string of comma separated values. If status is present, training courses with the specified status(s) will be returned. Valid values: “published”, “deleted”, “archived”. Defaults to returning all courses.", "explode": false, "in": "query", "name": "status", "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrainingCoursesGetTrainingCoursesBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get a list of filtered training courses.", "tags": [ "Beta APIs" ] } }, "/trips/stream": { "get": { "description": "This endpoint will return trips that have been collected for your organization based on the time parameters passed in. Results are paginated. Reach out to your Samsara Representative to have this API enabled for your organization.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Trips** under the Trips category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getTrips", "parameters": [ { "description": "Indicates whether or not to return expanded “asset” data", "in": "query", "name": "includeAsset", "schema": { "default": false, "type": "boolean" } }, { "description": "Filters trips based on a specific completion status Valid values: `inProgress`, `completed`, `all`", "in": "query", "name": "completionStatus", "schema": { "default": "all", "enum": [ "inProgress", "completed", "all" ], "type": "string" } }, { "description": "RFC 3339 timestamp that indicates when to begin receiving data. Value is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter.", "in": "query", "name": "startTime", "required": true, "schema": { "type": "string" } }, { "description": "RFC 3339 timestamp which is compared against `updatedAtTime` or `tripStartTime` depending on the queryBy parameter. If not provided then the endpoint behaves as an unending feed of changes.", "in": "query", "name": "endTime", "schema": { "type": "string" } }, { "description": "Decide which timestamp the `startTime` and `endTime` are compared to. Valid values: `updatedAtTime`, `tripStartTime`", "in": "query", "name": "queryBy", "schema": { "default": "updatedAtTime", "enum": [ "updatedAtTime", "tripStartTime" ], "type": "string" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } }, { "description": "Comma-separated list of asset IDs. Include up to 50 asset IDs.", "explode": false, "in": "query", "name": "ids", "required": true, "schema": { "items": { "type": "string" }, "type": "array" }, "style": "form" } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TripsGetTripsBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "[beta] Get trips", "tags": [ "Beta APIs" ] } }, "/user-roles": { "get": { "description": "Returns a list of all user roles in an organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Users** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "listUserRoles", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUserRolesResponse" } } }, "description": "List all user roles." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all user roles", "tags": [ "Users" ] } }, "/users": { "get": { "description": "Returns a list of all users in an organization. Users that have expired access will not be returned. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Users** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "listUsers", "parameters": [ { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "format": "int64", "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": "If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersResponse" } } }, "description": "List all users." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "List all users", "tags": [ "Users" ] }, "post": { "description": "Add a user to the organization. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Users** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "createUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } }, "description": "The user to create.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } }, "description": "Newly created user object with ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Create a user", "tags": [ "Users" ], "x-codegen-request-body-name": "user" } }, "/users/{id}": { "delete": { "description": "Delete the given user. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Users** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "deleteUser", "parameters": [ { "description": "Unique identifier for the user.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardDeleteResponse" } } }, "description": "A successful DELETE response is a 204 with no content." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Delete a user", "tags": [ "Users" ] }, "get": { "description": "Get a specific user's information. Users that have expired access will not be returned. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Users** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getUser", "parameters": [ { "description": "Unique identifier for the user.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } }, "description": "Returns the specified user." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Retrieve a user", "tags": [ "Users" ] }, "patch": { "description": "Update a specific user's information. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Users** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "updateUser", "parameters": [ { "description": "Unique identifier for the user.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserRequest" } } }, "description": "Updates to the user.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserResponse" } } }, "description": "Updated user object with ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/standardErrorResponse" } } }, "description": "Error response" } }, "summary": "Update a user", "tags": [ "Users" ], "x-codegen-request-body-name": "user" } }, "/v1/fleet/assets": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch all of the assets. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getAllAssets", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_1" } } }, "description": "List of assets." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List all assets", "tags": [ "Assets" ] } }, "/v1/fleet/assets/locations": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch current locations of all assets. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getAllAssetCurrentLocations", "parameters": [ { "description": "Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'endingBefore' parameter.", "in": "query", "name": "startingAfter", "schema": { "type": "string" } }, { "description": "Pagination parameter indicating the cursor position to return results before. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'startingAfter' parameter.", "in": "query", "name": "endingBefore", "schema": { "type": "string" } }, { "description": "Pagination parameter indicating the number of results to return in this request. Used in conjunction with either 'startingAfter' or 'endingBefore'.", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_2" } } }, "description": "List of assets and their current locations." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List current location for all assets", "tags": [ "Assets" ] } }, "/v1/fleet/assets/reefers": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetches all reefers and reefer-specific stats. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Trailers** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getAssetsReefers", "parameters": [ { "description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs.", "in": "query", "name": "startMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs.", "in": "query", "name": "endMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'endingBefore' parameter.", "in": "query", "name": "startingAfter", "schema": { "type": "string" } }, { "description": "Pagination parameter indicating the cursor position to return results before. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'startingAfter' parameter.", "in": "query", "name": "endingBefore", "schema": { "type": "string" } }, { "description": "Pagination parameter indicating the number of results to return in this request. Used in conjunction with either 'startingAfter' or 'endingBefore'.", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "number" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_3" } } }, "description": "All org reefers and reefer-specific details." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List stats for all reefers", "tags": [ "Assets" ] } }, "/v1/fleet/assets/{asset_id}/locations": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nList historical locations for a given asset. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Equipment Statistics** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getAssetLocation", "parameters": [ { "description": "ID of the asset. Must contain only digits 0-9.", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs.", "in": "query", "name": "startMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs.", "in": "query", "name": "endMs", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1AssetLocationResponse" } } }, "description": "Asset location details." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List historical locations for a given asset", "tags": [ "Assets" ] } }, "/v1/fleet/assets/{asset_id}/reefer": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch the reefer-specific stats of an asset. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Trailers** under the Trailers category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getAssetReefer", "parameters": [ { "description": "ID of the asset. Must contain only digits 0-9.", "in": "path", "name": "asset_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs.", "in": "query", "name": "startMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs.", "in": "query", "name": "endMs", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1AssetReeferResponse" } } }, "description": "Reefer-specific asset details." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List stats for a given reefer", "tags": [ "Assets" ] } }, "/v1/fleet/dispatch/routes/{route_id_or_external_id}": { "delete": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nDelete a dispatch route and its associated jobs. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Routes** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1deleteDispatchRouteById", "parameters": [ { "description": "ID of the route. This can either be the Samsara-specified ID, or an external ID. External IDs are customer specified key-value pairs created in the POST or PATCH requests of this resource. To specify an external ID as part of a path parameter, use the following format: `key:value`. For example, `payrollId:ABFS18600`", "in": "path", "name": "route_id_or_external_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "$ref": "#/components/requestBodies/inline_object", "content": { "application/json": { "schema": { "properties": { "apply_to_future_routes": { "description": "This is only for a recurring route. If set to true, delete all following runs of the route. If set to false, only delete the current route.", "example": true, "type": "boolean" } }, "type": "object" } } }, "required": false }, "responses": { "200": { "content": { }, "description": "Successfully deleted the dispatch route. No response body is returned." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Delete a route", "tags": [ "Routes" ], "x-codegen-request-body-name": "applyToFutureRoutes" } }, "/v1/fleet/drivers/{driverId}/safety/score": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch the safety score for the driver.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getDriverSafetyScore", "parameters": [ { "description": "ID of the driver. Must contain only digits 0-9.", "in": "path", "name": "driverId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour.", "in": "query", "name": "startMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour.", "in": "query", "name": "endMs", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1DriverSafetyScoreResponse" } } }, "description": "Safety score details." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Fetch driver safety score", "tags": [ "Safety" ] } }, "/v1/fleet/drivers/{driver_id}/hos/duty_status": { "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nSet an individual driver’s current duty status to 'On Duty' or 'Off Duty'.\n\n To ensure compliance with the ELD Mandate, only authenticated drivers can make direct duty status changes on their own logbook. Any system external to the Samsara Driver App using this endpoint to trigger duty status changes must ensure that such changes are only triggered directly by the driver in question and that the driver has been properly authenticated. This endpoint should not be used to algorithmically trigger duty status changes nor should it be used by personnel besides the driver to trigger duty status changes on the driver’s behalf. Carriers and their drivers are ultimately responsible for maintaining accurate logs and should confirm that their use of the endpoint is compliant with the ELD Mandate. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write ELD Hours of Service (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "setCurrentDutyStatus", "parameters": [ { "description": "ID of the driver for whom the duty status is being set.", "in": "path", "name": "driver_id", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "requestBody": { "$ref": "#/components/requestBodies/inline_object_1", "content": { "application/json": { "schema": { "properties": { "duty_status": { "description": "Duty status to set the driver to. The only supported values are 'ON_DUTY' and 'OFF_DUTY'.", "example": "ON_DUTY", "type": "string" }, "location": { "description": "Location to associate the duty status change with.", "example": "Loading dock", "type": "string" }, "remark": { "description": "Remark to associate the duty status change with.", "example": "Beginning On Duty Shift", "type": "string" }, "status_change_at_ms": { "description": "Timestamp that the duty status will begin at specified in milliseconds UNIX time. Defaults to the current time if left blank. This can only be set to up to 8 hours in the past.", "example": 1580834793568, "format": "int64", "type": "number" }, "vehicle_id": { "description": "Vehicle ID to associate the duty status change with.", "example": 1234, "format": "int64", "type": "number" } }, "required": [ "duty_status" ], "type": "object" } } }, "required": false }, "responses": { "200": { "content": { }, "description": "Successfully changed duty status. No response body is returned." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Set a duty status for a specific driver", "tags": [ "Hours of Service" ], "x-codegen-request-body-name": "dutyStatusParams" } }, "/v1/fleet/hos_authentication_logs": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet the HOS (hours of service) signin and signout logs for the specified driver. The response includes 4 fields that are now deprecated.\n\n**Note:** If data is still being uploaded from the Samsara Driver App, it may not be completely reflected in the response from this endpoint. The best practice is to wait a couple of days before querying this endpoint to make sure that all data from the Samsara Driver App has been uploaded. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read ELD Hours of Service (US)** under the Compliance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getFleetHosAuthenticationLogs", "parameters": [ { "description": "Driver ID to query.", "in": "query", "name": "driverId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Beginning of the time range, specified in milliseconds UNIX time.", "in": "query", "name": "startMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "End of the time range, specified in milliseconds UNIX time.", "in": "query", "name": "endMs", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1HosAuthenticationLogsResponse" } } }, "description": "HOS authentication logs for the specified driver." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get HOS signin and signout", "tags": [ "Hours of Service" ] } }, "/v1/fleet/maintenance/list": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet list of the vehicles with any engine faults or check light data. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read DVIRs** under the Maintenance category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getFleetMaintenanceList", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_4" } } }, "description": "List of vehicles and maintenance information about each." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get vehicles with engine faults or check lights", "tags": [ "Maintenance" ] } }, "/v1/fleet/messages": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet all messages. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 75 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Messages** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getMessages", "parameters": [ { "description": "Time in unix milliseconds that represents the end of time range of messages to return. Used in combination with durationMs. Defaults to now.", "in": "query", "name": "endMs", "schema": { "format": "int64", "type": "integer" } }, { "description": "Time in milliseconds that represents the duration before endMs to query. Defaults to 24 hours.", "in": "query", "name": "durationMs", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_5" } } }, "description": "Returns the fetched messages from most recently sent to least recently sent." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get all messages.", "tags": [ "Messages" ] }, "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nSend a message to a list of driver ids. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Messages** under the Driver Workflow category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1createMessages", "requestBody": { "$ref": "#/components/requestBodies/inline_object_2", "content": { "application/json": { "schema": { "properties": { "driverIds": { "description": "IDs of the drivers for whom the messages are sent to.", "example": [111, 222, 333], "items": { "example": 555, "format": "int64", "type": "number" }, "type": "array" }, "text": { "description": "The text sent in the message. Max 2500 characters allowed.", "example": "This is a message.", "type": "string" } }, "required": [ "driverIds", "text" ], "type": "object" } } }, "description": "Text to send to a list of driverIds.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_6" } } }, "description": "Returns the created messages." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Send a message to a list of driver ids.", "tags": [ "Messages" ], "x-codegen-request-body-name": "createMessages" } }, "/v1/fleet/trailers/assignments": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch trailer assignment data for all trailers in your organization. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getAllTrailerAssignments", "parameters": [ { "description": "Timestamp in Unix epoch miliseconds representing the start of the period to fetch. Omitting both startMs and endMs only returns current assignments.", "in": "query", "name": "startMs", "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in Unix epoch miliseconds representing the end of the period to fetch. Omitting endMs sets endMs as the current time", "in": "query", "name": "endMs", "schema": { "format": "int64", "type": "integer" } }, { "description": "Pagination parameter indicating the number of results to return in this request. Used in conjunction with either 'startingAfter' or 'endingBefore'.", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "number" } }, { "description": "Pagination parameter indicating the cursor position to continue returning results after. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'endingBefore' parameter.", "in": "query", "name": "startingAfter", "schema": { "type": "string" } }, { "description": "Pagination parameter indicating the cursor position to return results before. Used in conjunction with the 'limit' parameter. Mutually exclusive with 'startingAfter' parameter.", "in": "query", "name": "endingBefore", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_7" } } }, "description": "Returns trailer assignment data for all trailers in your organization" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List trailer assignments for all trailers", "tags": [ "Trailer Assignments" ] } }, "/v1/fleet/trailers/{trailerId}/assignments": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch trailer assignment data for a single trailer. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Assignments** under the Assignments category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getFleetTrailerAssignments", "parameters": [ { "description": "ID of trailer. Must contain only digits 0-9.", "in": "path", "name": "trailerId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in Unix epoch milliseconds representing the start of the period to fetch. Omitting both startMs and endMs only returns current assignments.", "in": "query", "name": "startMs", "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in Unix epoch milliseconds representing the end of the period to fetch. Omitting endMs sets endMs as the current time", "in": "query", "name": "endMs", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1TrailerAssignmentsResponse" } } }, "description": "Returns trailer assignment data for a single trailer" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "List trailer assignments for a given trailer", "tags": [ "Trailer Assignments" ] } }, "/v1/fleet/trips": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet historical trips data for specified vehicle. This method returns a set of historical trips data for the specified vehicle in the specified time range. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Vehicle Trips** under the Vehicles category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getFleetTrips", "parameters": [ { "description": "Vehicle ID to query.", "in": "query", "name": "vehicleId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Beginning of the time range, specified in milliseconds UNIX time. Limited to a 90 day window with respect to startMs and endMs", "in": "query", "name": "startMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "End of the time range, specified in milliseconds UNIX time.", "in": "query", "name": "endMs", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1TripResponse" } } }, "description": "List of trips taken by the requested vehicle within the specified timeframe. Ongoing trips will be returned with 9223372036854775807 as their endMs." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get vehicle trips", "tags": [ "Trips" ] } }, "/v1/fleet/vehicles/{vehicleId}/safety/harsh_event": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch harsh event details for a vehicle. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getVehicleHarshEvent", "parameters": [ { "description": "ID of the vehicle. Must contain only digits 0-9.", "in": "path", "name": "vehicleId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the timestamp of a harsh event.", "in": "query", "name": "timestamp", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1VehicleHarshEventResponse" } } }, "description": "Harsh event details." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Fetch harsh events", "tags": [ "Safety" ] } }, "/v1/fleet/vehicles/{vehicleId}/safety/score": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch the safety score for the vehicle. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Safety Events & Scores** under the Safety & Cameras category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getVehicleSafetyScore", "parameters": [ { "description": "ID of the vehicle. Must contain only digits 0-9.", "in": "path", "name": "vehicleId", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the start of the period to fetch, inclusive. Used in combination with endMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour.", "in": "query", "name": "startMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Timestamp in milliseconds representing the end of the period to fetch, inclusive. Used in combination with startMs. Total duration (endMs - startMs) must be greater than or equal to 1 hour.", "in": "query", "name": "endMs", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1VehicleSafetyScoreResponse" } } }, "description": "Safety score details." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Fetch vehicle safety scores", "tags": [ "Safety" ] } }, "/v1/industrial/vision/cameras": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch all cameras. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getCameras", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1VisionCamerasResponse" } } }, "description": "Returns details about a camera." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Fetch industrial cameras", "tags": [ "Industrial" ] } }, "/v1/industrial/vision/cameras/{camera_id}/programs": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch configured programs on the camera. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getVisionProgramsByCamera", "parameters": [ { "description": "The camera_id should be valid for the given accessToken.", "in": "path", "name": "camera_id", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ProgramsForTheCameraResponse" } } }, "description": "Returns programs configured on the camera." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Fetch industrial camera programs", "tags": [ "Industrial" ] } }, "/v1/industrial/vision/run/camera/{camera_id}": { "get": { "description": "Fetch the latest run for a camera or program by default. If startedAtMs is supplied, fetch the specific run that corresponds to that start time. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getVisionLatestRunCamera", "parameters": [ { "description": "The camera_id should be valid for the given accessToken.", "in": "path", "name": "camera_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "The configured program's ID on the camera.", "in": "query", "name": "program_id", "schema": { "format": "int64", "type": "integer" } }, { "description": "EndMs is an optional param. It will default to the current time.", "in": "query", "name": "startedAtMs", "schema": { "format": "int64", "type": "integer" } }, { "description": "Include is a filter parameter. Accepts 'pass', 'reject' or 'no_read'.", "in": "query", "name": "include", "schema": { "type": "string" } }, { "description": "Limit is an integer value from 1 to 1,000.", "in": "query", "name": "limit", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1VisionRunByCameraResponse" } } }, "description": "Returns the details for this run." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Fetch the latest run for a camera or program", "tags": [ "Industrial" ] } }, "/v1/industrial/vision/runs": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch runs. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getVisionRuns", "parameters": [ { "description": "DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched", "in": "query", "name": "durationMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "EndMs is an optional param. It will default to the current time.", "in": "query", "name": "endMs", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1VisionRunsResponse" } } }, "description": "Return runs." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Fetch runs", "tags": [ "Industrial" ] } }, "/v1/industrial/vision/runs/{camera_id}": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch runs by camera. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "getVisionRunsByCamera", "parameters": [ { "description": "The camera_id should be valid for the given accessToken.", "in": "path", "name": "camera_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "DurationMs is a required param. This works with the EndMs parameter. Indicates the duration in which the visionRuns will be fetched", "in": "query", "name": "durationMs", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "EndMs is an optional param. It will default to the current time.", "in": "query", "name": "endMs", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1VisionRunsByCameraResponse" } } }, "description": "Return runs by cameraId." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Fetch runs by camera", "tags": [ "Industrial" ] } }, "/v1/industrial/vision/runs/{camera_id}/{program_id}/{started_at_ms}": { "get": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nFetch runs by camera and program. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Read Industrial** under the Industrial category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getVisionRunsByCameraAndProgram", "parameters": [ { "description": "The camera_id should be valid for the given accessToken.", "in": "path", "name": "camera_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "The configured program's ID on the camera.", "in": "path", "name": "program_id", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Started_at_ms is a required param. Indicates the start time of the run to be fetched.", "in": "path", "name": "started_at_ms", "required": true, "schema": { "format": "int64", "type": "integer" } }, { "description": "Include is a filter parameter. Accepts 'pass', 'reject' or 'no_read'.", "in": "query", "name": "include", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1VisionRunsByCameraAndProgramResponse" } } }, "description": "Return runs by camera ID and program ID." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Fetch runs by camera and program", "tags": [ "Industrial" ] } }, "/v1/machines/history": { "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet historical data for machine objects. This method returns a set of historical data for all machines. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getMachinesHistory", "requestBody": { "$ref": "#/components/requestBodies/inline_object_3", "content": { "application/json": { "schema": { "properties": { "endMs": { "description": "End of the time range, specified in milliseconds UNIX time.", "example": 1462881998034, "type": "integer" }, "startMs": { "description": "Beginning of the time range, specified in milliseconds UNIX time.", "example": 1462878398034, "type": "integer" } }, "required": [ "endMs", "startMs" ], "type": "object" } } }, "description": "Time range to query for events", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1MachineHistoryResponse" } } }, "description": "List of machine results objects, each containing a time and a datapoint." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get machine history", "tags": [ "Industrial" ], "x-codegen-request-body-name": "historyParam" } }, "/v1/machines/list": { "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet machine objects. This method returns a list of the machine objects in the Samsara Cloud and information about them. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Industrial** under the Industrial category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getMachines", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_8" } } }, "description": "List of machine objects." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get machines", "tags": [ "Industrial" ] } }, "/v1/sensors/cargo": { "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet cargo monitor status (empty / full) for requested sensors. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getSensorsCargo", "requestBody": { "$ref": "#/components/requestBodies/inline_object_4", "content": { "application/json": { "schema": { "properties": { "sensors": { "description": "List of sensor IDs to query.", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "sensors" ], "type": "object" } } }, "description": "List of sensor IDs to query.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1CargoResponse" } } }, "description": "List of sensor objects containing the current cargo status reported by each sensor." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get cargo status", "tags": [ "Sensors" ], "x-codegen-request-body-name": "V1sensorParam" } }, "/v1/sensors/door": { "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet door monitor status (closed / open) for requested sensors. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getSensorsDoor", "requestBody": { "$ref": "#/components/requestBodies/inline_object_5", "content": { "application/json": { "schema": { "properties": { "sensors": { "description": "List of sensor IDs to query.", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "sensors" ], "type": "object" } } }, "description": "List of sensor IDs to query.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1DoorResponse" } } }, "description": "List of sensor objects containing the current door status reported by each sensor." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get door status", "tags": [ "Sensors" ], "x-codegen-request-body-name": "V1sensorParam" } }, "/v1/sensors/history": { "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet historical data for specified sensors. This method returns a set of historical data for the specified sensors in the specified time range and at the specified time resolution. \n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E). \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getSensorsHistory", "requestBody": { "$ref": "#/components/requestBodies/inline_object_6", "content": { "application/json": { "schema": { "properties": { "endMs": { "description": "End of the time range, specified in milliseconds UNIX time.", "example": 1462881998034, "type": "integer" }, "fillMissing": { "default": "withNull", "enum": [ "withNull", "withPrevious" ], "type": "string" }, "series": { "items": { "$ref": "#/components/schemas/_v1_sensors_history_series" }, "maxItems": 40, "type": "array" }, "startMs": { "description": "Beginning of the time range, specified in milliseconds UNIX time.", "example": 1462878398034, "type": "integer" }, "stepMs": { "description": "Time resolution for which data should be returned, in milliseconds. Specifying 3600000 will return data at hour intervals.", "example": 3600000, "type": "integer" } }, "required": [ "endMs", "series", "startMs", "stepMs" ], "type": "object" } } }, "description": "Time range and resolution, and list of sensor ID, field pairs to query.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1SensorHistoryResponse" } } }, "description": "List of results objects, each containing a time and a datapoint for each requested sensor/field pair." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get sensor history", "tags": [ "Sensors" ], "x-codegen-request-body-name": "historyParam" } }, "/v1/sensors/humidity": { "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet humidity for requested sensors. This method returns the current relative humidity for the requested sensors. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getSensorsHumidity", "requestBody": { "$ref": "#/components/requestBodies/inline_object_7", "content": { "application/json": { "schema": { "properties": { "sensors": { "description": "List of sensor IDs to query.", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "sensors" ], "type": "object" } } }, "description": "List of sensor IDs to query.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1HumidityResponse" } } }, "description": "List of sensor objects containing the current humidity reported by each sensor." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get humidity", "tags": [ "Sensors" ], "x-codegen-request-body-name": "V1sensorParam" } }, "/v1/sensors/list": { "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet sensor objects. This method returns a list of the sensor objects in the Samsara Cloud and information about them. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getSensors", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inline_response_200_9" } } }, "description": "List of sensor objects." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get all sensors", "tags": [ "Sensors" ] } }, "/v1/sensors/temperature": { "post": { "description": "\u003Cn class=\"warning\"\u003E\n\u003Cnh\u003E\n\u003Ci class=\"fa fa-exclamation-circle\"\u003E\u003C/i\u003E\nThis endpoint is still on our legacy API.\n\u003C/nh\u003E\n\u003C/n\u003E\n\nGet temperature for requested sensors. This method returns the current ambient temperature (and probe temperature if applicable) for the requested sensors. \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.\n\nTo use this endpoint, select **Write Sensors** under the Equipment category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E", "operationId": "V1getSensorsTemperature", "requestBody": { "$ref": "#/components/requestBodies/inline_object_8", "content": { "application/json": { "schema": { "properties": { "sensors": { "description": "List of sensor IDs to query.", "example": [122], "items": { "format": "int64", "type": "integer" }, "type": "array" } }, "required": [ "sensors" ], "type": "object" } } }, "description": "List of sensor IDs to query.", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1TemperatureResponse" } } }, "description": "List of sensor objects containing the current temperature reported by each sensor." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V1ErrorResponse" } } }, "description": "Unexpected error." } }, "summary": "Get temperature", "tags": [ "Sensors" ], "x-codegen-request-body-name": "V1sensorParam" } }, "/webhooks": { "get": { "description": "List all webhooks belonging to a specific org.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Webhooks** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "listWebhooks", "parameters": [ { "description": " A filter on the data based on this comma-separated list of webhook IDs. Example: `ids=49412323223,49412329928`", "in": "query", "name": "ids", "schema": { "type": "string" } }, { "description": "The limit for how many objects will be in the response. Default and max for this value is 512 objects.", "in": "query", "name": "limit", "schema": { "default": 512, "maximum": 512, "minimum": 1, "type": "integer" } }, { "description": " If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.", "in": "query", "name": "after", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksListWebhooksBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "List all webhooks belonging to a specific org.", "tags": [ "Webhooks" ] }, "post": { "description": "Create a webhook\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Webhooks** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "postWebhooks", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPostWebhooksBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Create a webhook", "tags": [ "Webhooks" ], "x-codegen-request-body-name": "PostWebhooksRequestBody" } }, "/webhooks/{id}": { "delete": { "description": "Delete a webhook with the given ID.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Webhooks** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "deleteWebhook", "parameters": [ { "description": "Unique identifier for the webhook to delete.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "content": { }, "description": "No Content response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksDeleteWebhookBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Delete a webhook with the given ID", "tags": [ "Webhooks" ] }, "get": { "description": "Retrieve a webhook with given ID.\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 5 requests/sec (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Read Webhooks** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "getWebhook", "parameters": [ { "description": "ID of the webhook. This is the Samsara-specified ID.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksGetWebhookBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Retrieve a webhook with given ID", "tags": [ "Webhooks" ] }, "patch": { "description": "Update a specific webhook's information. **Note** this implementation of patch uses [the JSON merge patch](https://tools.ietf.org/html/rfc7396) proposed standard.\n This means that any fields included in the patch request will _overwrite_ fields which exist on the target resource.\n For arrays, this means any array included in the request will _replace_ the array that exists at the specified path, it will not _add_ to the existing array\n\n \u003Cb\u003ERate limit:\u003C/b\u003E 100 requests/min (learn more about rate limits \u003Ca href=\"https://developers.samsara.com/docs/rate-limits\" target=\"_blank\"\u003Ehere\u003C/a\u003E).\n\nTo use this endpoint, select **Write Webhooks** under the Setup & Administration category when creating or editing an API token. \u003Ca href=\"https://developers.samsara.com/docs/authentication#scopes-for-api-tokens\" target=\"_blank\"\u003ELearn More.\u003C/a\u003E\n \n\n **Submit Feedback**: Likes, dislikes, and API feature requests should be filed as feedback in our \u003Ca href=\"https://forms.gle/zkD4NCH7HjKb7mm69\" target=\"_blank\"\u003EAPI feedback form\u003C/a\u003E. If you encountered an issue or noticed inaccuracies in the API documentation, please \u003Ca href=\"https://www.samsara.com/help\" target=\"_blank\"\u003Esubmit a case\u003C/a\u003E to our support team.", "operationId": "patchWebhook", "parameters": [ { "description": "Unique identifier for the webhook to update.", "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookRequestBody" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookResponseBody" } } }, "description": "OK response." }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookUnauthorizedErrorResponseBody" } } }, "description": "Unauthorized response." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookNotFoundErrorResponseBody" } } }, "description": "Not Found response." }, "405": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookMethodNotAllowedErrorResponseBody" } } }, "description": "Method Not Allowed response." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookTooManyRequestsErrorResponseBody" } } }, "description": "Too Many Requests response." }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookInternalServerErrorResponseBody" } } }, "description": "Internal Server Error response." }, "501": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookNotImplementedErrorResponseBody" } } }, "description": "Not Implemented response." }, "502": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookBadGatewayErrorResponseBody" } } }, "description": "Bad Gateway response." }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookServiceUnavailableErrorResponseBody" } } }, "description": "Service Unavailable response." }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookGatewayTimeoutErrorResponseBody" } } }, "description": "Gateway Timeout response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhooksPatchWebhookBadRequestErrorResponseBody" } } }, "description": "Bad Request response." } }, "summary": "Update a specific webhook's information.", "tags": [ "Webhooks" ], "x-codegen-request-body-name": "PatchWebhookRequestBody" } } }, "security": [ { "AccessTokenHeader": [] } ], "servers": [ { "url": "https://api.samsara.com/" }, { "url": "https://api.eu.samsara.com/" } ], "tags": [ { "name": "Addresses" }, { "name": "Assets" }, { "name": "Attributes" }, { "name": "Camera Media" }, { "name": "Carrier Proposed Assignments" }, { "name": "Contacts" }, { "name": "Documents" }, { "name": "Drivers" }, { "name": "Driver Vehicle Assignments" }, { "name": "Equipment" }, { "name": "Hours of Service" }, { "name": "Industrial" }, { "name": "Maintenance" }, { "name": "Messages" }, { "name": "Organization Info" }, { "name": "Routes" }, { "name": "Safety" }, { "name": "Sensors" }, { "name": "Tachograph (EU Only)" }, { "name": "Tags" }, { "name": "Trailer Assignments" }, { "name": "Trips" }, { "name": "Users" }, { "name": "Vehicles" }, { "name": "Vehicle Driver Assignments" }, { "name": "Vehicle Stats" }, { "name": "Vehicle Locations" }, { "name": "Beta APIs" }, { "name": "Preview APIs" }, { "name": "Legacy APIs" } ], "x-original-swagger-version": "2.0", "x-readme": { "explorer-enabled": true, "proxy-enabled": true } }