The identity and technical contract details declared by the specification.
FormsPersonValueObjectResponseBody
object
The value of a person form input field.
1 property
1 required
AssetsCreateAssetRequestBody
object
Representation of a vehicle trailer or other equipment to be tracked.
11 properties
TrailerStatReeferSetPointTemperatureMilliCZone2WithDecorationsTypeResponseBody
object
Set point temperature of zone 2 of the reefer.
3 properties
2 required
JobsPatchJobNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
JobsDeleteJobGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AempEquipmentGetAempEquipmentListResponseBody
object
1 property
1 required
TrailerStatsGetTrailerStatsHistoryNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AssetsListAssetsResponseBody
object
2 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
FormsNumberValueObjectResponseBody
object
The value of a number form input field.
1 property
1 required
TrailerStatReeferStateZone2TypeResponseBody
object
Reefer state event.
3 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
IssuesGetIssuesUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerStatReeferFuelPercentTypeResponseBody
object
The fuel percentage of the reefer.
2 properties
2 required
AssetsListAssetsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
AssetsDeleteAssetServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrailerStatReeferDoorStateZone2WithDecorationsTypeResponseBody
object
Door stats that have been emitted by the reefer.
3 properties
2 required
LocationResponseBody
object
Equipment location.
3 properties
AssetsUpdateAssetBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrailerStatsGetTrailerStatsFeedMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
AssetsInputsGetAssetsInputsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
AssetsUpdateAssetNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
AssetsListAssetsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
SpeedingIntervalResponseBody
object
Speeding Interval Object
7 properties
7 required
JobsGetJobsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AssetsDeleteAssetNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerStatGpsOdometerMetersTypeResponseBody
object
Trailer GPS odometer event.
2 properties
2 required
IssuesPatchIssueBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferSetPointTemperatureMilliCZone3WithDecorationsTypeResponseBody
object
Set point temperature of zone 3 of the reefer.
3 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferStateZone3WithDecorationsTypeResponseBody
object
Reefer state event.
4 properties
2 required
EquipmentPatchEquipmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
AssetsInputsGetAssetsInputsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
JobsCreateJobNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AempEquipmentGetAempEquipmentListUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
GoaAttributeTiny
object
Attribute properties.
4 properties
TrailerStatReeferAlarmTypeResponseBody
object
Alarms that have been emitted by the reefer.
2 properties
2 required
JobsDeleteJobNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatsGetTrailerStatsFeedServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrailerStatReeferRunModeWithDecorationsTypeResponseBody
object
The run mode of the reefer.
3 properties
2 required
IssuesPatchIssueNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
FormsLocationObjectResponseBody
object
Form template location object.
2 properties
2 required
AssetsInputsGetAssetsInputsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
EquipmentPatchEquipmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AempEquipmentGetAempEquipmentListNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
AssetsDeleteAssetNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryResponseBody
object
2 properties
2 required
IssuesPatchIssueServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
AssetsInputsGetAssetsInputsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatReeferSetPointTemperatureMilliCZone3TypeResponseBody
object
Set point temperature of zone 3 of the reefer.
2 properties
2 required
TrailerStatReeferStateZone3TypeResponseBody
object
Reefer state event.
3 properties
2 required
JobsPatchJobNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AssetsCreateAssetNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
IssuesGetIssuesBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferAlarmWithDecorationsTypeResponseBody
object
Alarms that have been emitted by the reefer.
3 properties
2 required
AssetsDeleteAssetBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
fleetDeviceObjectResponseBody
object
fleetDeviceObject
2 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone1WithDecorationsTypeResponseBody
object
Return air temperature of zone 1 of the reefer. This is the temperature of the air as it enters the cooling unit.
3 properties
2 required
IssuesGetIssuesResponseBody
object
1 property
1 required
EquipmentWithAttributesResponseObjectResponseBody
object
The equipment object.
8 properties
AempEquipmentGetAempEquipmentListInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
JobsDeleteJobServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
FormsTextValueObjectResponseBody
object
The value of a text form input field.
1 property
1 required
JobsPatchJobRequestBody
object
Job object with fields to update. If a field is not provided, it will not be updated
2 properties
1 required
FormsTableCellObjectResponseBody
object
Defines a cell in a table row.
10 properties
2 required
FormSubmissionResponseObjectResponseBody
object
Form Submission response object.
17 properties
8 required
FormsSignatureValueObjectResponseBody
object
The value of a signature form input field.
1 property
1 required
EquipmentPatchEquipmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
AssetResponseBody
object
Representation of a vehicle trailer or other equipment to be tracked.
15 properties
3 required
AssetsUpdateAssetRequestBody
object
Representation of a vehicle trailer or other equipment to be tracked.
11 properties
EquipmentPatchEquipmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
AssetsCreateAssetTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
AssetsListAssetsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
FormsMediaRecordObjectResponseBody
object
Forms media record object.
4 properties
2 required
TrailerStatReeferRunModeTypeResponseBody
object
The run mode of the reefer.
2 properties
2 required
IssuesGetIssuesTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
JobsGetJobsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TrailerStatReeferAmbientAirTemperatureWithDecorationsTypeResponseBody
object
Reefer ambient air temperature reading.
3 properties
2 required
AempEquipmentWithAdditionalFieldsResponseBody
object
Contains equipment fields.
7 properties
2 required
AssetsListAssetsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
IssuesGetIssuesBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
AssetsListAssetsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
EngineStatusResponseBody
object
Equipment engine status.
2 properties
JobsPatchJobMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
assetsInputsResponseResponseBody
object
Full assets inputs objects.
5 properties
4 required
PatchIssueRequestBodyAssignedToRequestBody
object
Issue assignee update object
2 properties
2 required
JobsCreateJobNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
JobsGetJobsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
FormsTableValueObjectResponseBody
object
The value of a table form input field.
2 properties
2 required
TrailerAssignmentsUpdateDriverTrailerAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferDoorStateZone3WithDecorationsTypeResponseBody
object
Door stats that have been emitted by the reefer.
3 properties
2 required
TripAssetResponseBody
object
Asset that the location readings are tied to
4 properties
1 required
JobsCreateJobServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
JobsGetJobsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrailerStatsGetTrailerStatsFeedBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
JobsDeleteJobBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
FormSubmissionsGetFormSubmissionsStreamTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
FormsScoreObjectResponseBody
object
Forms score object.
3 properties
3 required
SpeedingIntervalsGetSpeedingIntervalsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
SpeedingIntervalLocationResponseResponseBody
object
Location object of the closest location point to the interval.
5 properties
4 required
EquipmentPatchEquipmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
AempFleetListResponseBody
object
Contains a list of equipment objects and links
4 properties
4 required
FormsAssetObjectResponseBody
object
Tracked or untracked (i.e. manually entered) asset object.
3 properties
1 required
JobsDeleteJobUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
AssetsDeleteAssetTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
AssetsUpdateAssetGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrailerObjectResponseBody
object
A trailer asset object associate with the assigment.
1 property
1 required
FormSubmissionsGetFormSubmissionsStreamGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AssetsCreateAssetNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone3WithDecorationsTypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
3 properties
2 required
GoaGatewayTinyResponseResponseBody
object
A minified gateway object
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferStateWithDecorationsTypeResponseBody
object
Reefer state event.
4 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone2WithDecorationsTypeResponseBody
object
Return air temperature of zone 2 of the reefer. This is the temperature of the air as it enters the cooling unit.
3 properties
2 required
AssetsCreateAssetMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
JobsGetJobsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
FormsTableColumnObjectResponseBody
object
Defines a column in a table form input field.
3 properties
3 required
AssetsListAssetsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
JobsGetJobsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
IssuesGetIssuesMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
FormSubmissionsGetFormSubmissionsStreamBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone1TypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
2 properties
2 required
AssetsDeleteAssetBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
FormTemplateReferenceObjectResponseBody
object
Form template reference object.
2 properties
2 required
TrailerStatsGetTrailerStatsFeedResponseBody
object
2 properties
2 required
JobsGetJobsResponseBody
object
4 properties
2 required
assetsInputsAuxInputResponseBody
object
Auxiliary input metadata
1 property
1 required
TrailerStatGpsWithDecorationsTypeResponseBody
object
GPS location data for the trailer.
7 properties
3 required
PatchJobObjectjobLocationRequestObjectRequestBody
object
A location object for the job
4 properties
4 required
TrailerStatsGetTrailerStatsHistoryMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
FormSubmissionsGetFormSubmissionsStreamNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
FormSubmissionsGetFormSubmissionsStreamMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
AssetsInputsGetAssetsInputsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerStatReeferObdEngineSecondsTypeResponseBody
object
Reefer onboard engine seconds reading.
2 properties
2 required
JobsCreateJobBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
EquipmentPatchEquipmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
IssuesPatchIssueBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
AssetsDeleteAssetGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AssetsDeleteAssetUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
PostJobObjectRequestBody
object
Job object to be created
11 properties
4 required
PatchJobObjectRequestBody
object
Job object with fields to update. If a field is not provided, it will not be updated
11 properties
AssetsDeleteAssetInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
FormsMediaValueObjectResponseBody
object
The value of a media form input field.
1 property
1 required
TrailerStatReeferSetPointTemperatureMilliCZone2TypeResponseBody
object
Set point temperature of zone 2 of the reefer.
2 properties
2 required
AssetsInputsGetAssetsInputsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
EquipmentPatchEquipmentResponseBody
object
1 property
1 required
TrainingAssignmentsGetTrainingAssignmentsStreamResponseBody
object
2 properties
2 required
AssetsUpdateAssetNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
JobsCreateJobBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
JobsPatchJobTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
AempLinkResponseBody
object
Contains a list of relevant links
2 properties
2 required
AempEquipmentGetAempEquipmentListNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone2WithDecorationsTypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
3 properties
2 required
TrailerStatReeferDoorStateZone1TypeResponseBody
object
The door state of the reefer.
2 properties
2 required
JobsCreateJobUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
AssetsCreateAssetInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
AssetsInputsGetAssetsInputsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone3TypeResponseBody
object
Return air temperature of zone 3 of the reefer. This is the temperature of the air as it enters the cooling unit.
2 properties
2 required
TrailerStatReeferStateTypeResponseBody
object
Reefer state event.
3 properties
2 required
FormsMultipleChoiceValueObjectResponseBody
object
The value of a multiple choice form input field.
1 property
1 required
JobsCreateJobRequestBody
object
Job object to be created
1 property
1 required
IssuesPatchIssueUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerStatReeferDoorStateZone1WithDecorationsTypeResponseBody
object
Door stats that have been emitted by the reefer.
3 properties
2 required
EquipmentPatchEquipmentRequestBody
object
9 properties
JobsGetJobsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TripSpeedingIntervalsResponseBody
object
TripSpeedingIntervals
6 properties
5 required
AempEquipmentGetAempEquipmentListBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
FormSubmissionsGetFormSubmissionsStreamNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerAssignmentsUpdateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerStatReeferObdEngineSecondsWithDecorationsTypeResponseBody
object
Reefer onboard engine seconds reading.
3 properties
2 required
JobsDeleteJobInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
FormSubmissionsGetFormSubmissionsStreamServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
GoaAttributeTinyResponseBody
object
Attribute properties.
4 properties
IssuesPatchIssueGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
jobLocationResponseObjectResponseBody
object
jobLocation object
4 properties
4 required
AssetsListAssetsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
AempEquipmentGetAempEquipmentListBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatReeferAmbientAirTemperatureMilliCTypeResponseBody
object
Reefer ambient air temperature reading.
2 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
IssuesGetIssuesNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerAssignmentsUpdateDriverTrailerAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerAssignmentsUpdateDriverTrailerAssignmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrailerStatsGetTrailerStatsFeedBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
JobsCreateJobGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
IssuesPatchIssueInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone3TypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone1WithDecorationsTypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
3 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
JobsPatchJobUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
IssueSourceObjectResponseBody
object
Contains information about where an issue came from.
2 properties
1 required
industrialAssetObjectResponseBody
object
industrialAssetObject
2 properties
2 required
TrailerStatsObjectResponseBody
object
A trailer and its stats
25 properties
2 required
TrailerStatReeferSetPointTemperatureMilliCZone1TypeResponseBody
object
Set point temperature of zone 1 of the reefer.
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
FormSubmissionsGetFormSubmissionsStreamResponseBody
object
2 properties
2 required
TrailerStatReeferDoorStateZone3TypeResponseBody
object
The door state of the reefer.
2 properties
2 required
EquipmentHeaderWithAdditionalFieldsResponseBody
object
Equipment header fields.
6 properties
TrailerStatReeferSetPointTemperatureMilliCZone1WithDecorationsTypeResponseBody
object
Set point temperature of zone 1 of the reefer.
3 properties
2 required
EquipmentPatchEquipmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
FormSubmissionsGetFormSubmissionsStreamInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsResponseBody
object
2 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone2TypeResponseBody
object
Return air temperature of zone 2 of the reefer. This is the temperature of the air as it enters the cooling unit.
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
EquipmentPatchEquipmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DEFRemainingResponseBody
object
DEF remaining in equipment.
2 properties
TrailerStatReeferAlarmResponseBody
object
4 properties
4 required
AssetsUpdateAssetMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
GoaTagTinyResponseResponseBody
object
A minified tag object
3 properties
2 required
AssetsDeleteAssetMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
PostDriverTrailerAssignmentsResponseBodyResponseBody
object
Response after successfully submitting a Driver Trailer Assignment
6 properties
6 required
JobsGetJobsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
IssuesGetIssuesGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AssetsCreateAssetBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerStatsGetTrailerStatsFeedGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrailerStatReeferSupplyAirTemperatureMilliCZone2TypeResponseBody
object
Supply or discharge air temperature of zone 2 of the reefer. This is the temperature of the air as it leaves the cooling unit.
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrailerStatsGetTrailerStatsFeedNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerAssignmentsUpdateDriverTrailerAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
AssetsUpdateAssetServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
FormsTableRowObjectResponseBody
object
Defines a row in a table form input field.
2 properties
2 required
JobsCreateJobResponseBody
object
3 properties
1 required
TrailerStatsGetTrailerStatsFeedTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TrailerAssignmentsUpdateDriverTrailerAssignmentResponseBody
object
1 property
1 required
TrailerAssignmentsGetDriverTrailerAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TrainingLearnerObjectResponseBody
object
Learner that is associated with the training assignment. Only driver learners are supported currently.
2 properties
2 required
JobsDeleteJobMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AssetsInputsAssetResponseResponseBody
object
Asset that the input data is from.
4 properties
1 required
AssetsInputsGetAssetsInputsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
JobsDeleteJobTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
AempEquipmentGetAempEquipmentListServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrailerStatReeferStateZone2WithDecorationsTypeResponseBody
object
Reefer state event.
4 properties
2 required
IssuesPatchIssueMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
IssuesGetIssuesNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
FormsCheckBoxesValueObjectResponseBody
object
The value of a check boxes form input field.
1 property
1 required
DriverWithExternalIdObjectResponseBody
object
A driver object with an id and map of external ids.
2 properties
1 required
JobResponseObjectResponseBody
object
Job object to be passed back
15 properties
11 required
TrailerAssignmentsUpdateDriverTrailerAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DistanceResponseBody
object
Equipment odometer distance.
3 properties
FormsDateTimeValueObjectResponseBody
object
The value of a datetime form input field.
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrailerStatReeferStateZone1TypeResponseBody
object
Reefer state event.
3 properties
2 required
IssuesPatchIssueRequestBody
object
Issue fields to update.
5 properties
1 required
TrailerAssignmentsUpdateDriverTrailerAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
AssetsListAssetsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AssetsCreateAssetGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
JobsPatchJobServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
AempEquipmentGetAempEquipmentListTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TrainingCourseObjectResponseBody
object
Course that is associated with the training assignments.
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
JobsCreateJobInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
FormSubmissionsGetFormSubmissionsStreamUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
AssetsCreateAssetUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
AssetsUpdateAssetInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
JobsGetJobsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatDecorationResponseBody
object
Decorated values for the primary trailer stat datapoints.
23 properties
PostJobObjectjobLocationRequestObjectRequestBody
object
A location object for the job
4 properties
4 required
TrailerAssignmentsCreateDriverTrailerAssignmentRequestBody
object
Create a new driver-trailer assignment
3 properties
2 required
TrailerAssignmentsUpdateDriverTrailerAssignmentRequestBody
object
Update a new driver-trailer assignment
1 property
1 required
JobsPatchJobGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
FormsPolymorphicUserObjectResponseBody
object
User or driver object.
2 properties
2 required
CumulativeOperatingHoursResponseBody
object
Equipment operating hours.
2 properties
GetDriverTrailerAssignmentsResponseBodyResponseBody
object
Object with driver assignment information and associated driver and trailer information.
7 properties
4 required
AssetsListAssetsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone3WithDecorationsTypeResponseBody
object
Return air temperature of zone 3 of the reefer. This is the temperature of the air as it enters the cooling unit.
3 properties
2 required
AssetsUpdateAssetUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
FuelRemainingResponseBody
object
Fuel remaining in equipment.
2 properties
TrailerAssignmentsUpdateDriverTrailerAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
IssueResponseObjectResponseBody
object
Issue response object.
15 properties
8 required
JobsDeleteJobBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
JobsPatchJobBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
FormsPersonObjectResponseBody
object
Tracked or untracked (i.e. manually entered) person object.
3 properties
1 required
EquipmentPatchEquipmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
JobsPatchJobResponseBody
object
3 properties
1 required
EquipmentPatchEquipmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AssetsInputsGetAssetsInputsResponseBody
object
2 properties
2 required
TrailerStatReeferDoorStateZone2TypeResponseBody
object
The door state of the reefer.
2 properties
2 required
AssetsUpdateAssetBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
AssetsCreateAssetResponseBody
object
15 properties
3 required
TrailerStatsGetTrailerStatsHistoryGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
JobsDeleteJobNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AssetsListAssetsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrailerStatsGetTrailerStatsHistoryUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
AempEquipmentGetAempEquipmentListMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
IssuesGetIssuesInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerStatReeferReturnAirTemperatureMilliCZone1TypeResponseBody
object
Return air temperature of zone 1 of the reefer. This is the temperature of the air as it enters the cooling unit.
2 properties
2 required
AssetsCreateAssetBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentResponseBody
object
1 property
1 required
AssetsCreateAssetServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
AssetsInputsGetAssetsInputsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
JobsCreateJobMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrailerAssignmentsGetDriverTrailerAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
AssetsInputsGetAssetsInputsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
JobsDeleteJobResponseBody
object
2 properties
FormsAssetValueObjectResponseBody
object
The value of an asset form input field.
1 property
1 required
IssuesGetIssuesServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
JobsPatchJobInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrailerStatReeferStateZone1WithDecorationsTypeResponseBody
object
Reefer state event.
4 properties
2 required
AempEquipmentGetAempEquipmentListGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrailerStatsGetTrailerStatsFeedUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrailerStatGpsTypeResponseBody
object
GPS location data for the trailer.
6 properties
3 required
TrailerStatGpsOdometerMetersWithDecorationsTypeResponseBody
object
Trailer GPS odometer event.
3 properties
2 required
JobsGetJobsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
FormsIssueCreatedByFieldObjectResponseBody
object
Issue created from this form input field input object.
2 properties
1 required
ReverseGeoObjectResponseBody
object
Reverse geocoded information
1 property
TrailerStatsGetTrailerStatsFeedInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
JobsPatchJobBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
SpeedingIntervalsGetSpeedingIntervalsResponseBody
object
2 properties
2 required
TrailerAssignmentsCreateDriverTrailerAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
IssuesPatchIssueTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
FormsFieldInputObjectResponseBody
object
Forms input field object.
16 properties
2 required
TrailerStatsGetTrailerStatsFeedNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AddressResponseResponseBody
object
Closest address that the GPS latitude and longitude match to.
8 properties
JobsCreateJobTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
IssuesPatchIssueNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
AssetsUpdateAssetTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TrainingAssignmentResponseObjectResponseBody
object
Training Assignment response object.
16 properties
9 required
TrailerStatReeferFuelPercentWithDecorationsTypeResponseBody
object
The fuel percentage of the reefer.
3 properties
2 required
AssetsUpdateAssetResponseBody
object
15 properties
3 required
TrailerAssignmentsUpdateDriverTrailerAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
IssuesPatchIssueResponseBody
object
1 property
1 required
FormSubmissionsGetFormSubmissionsStreamBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrailerAssignmentsUpdateDriverTrailerAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
PatchDriverTrailerAssignmentsResponseBodyResponseBody
object
Response after successfully updating a Driver Trailer Assignment
7 properties
5 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Samsara publishes across the network.