The identity and technical contract details declared by the specification.
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
V1ErrorResponse
string
Error message describing why the request failed.
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsResponseBody
object
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentResponseBody
object
1 property
1 required
standardErrorResponse
object
Error response
2 properties
DriverCoachAssignmentsGetDriverCoachAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
CarrierProposedAssignmentId
string
Samsara ID for the assignment.
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
TrainingCourseObjectResponseBody
object
Course that is associated with the training assignments.
2 properties
2 required
GoaVehicleTinyResponseResponseBody
object
A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
3 properties
DriverCoachAssignmentsPutDriverCoachAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverAssignmentMetadataTinyObjectResponseBody
object
Metadata object for external assignment source data.
1 property
DriversVehicleAssignmentsGetDriversVehicleAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsResponseBody
object
2 properties
2 required
TrainingAssignmentPostResponseObjectResponseBody
object
Training Assignment response object.
7 properties
6 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentResponseBody
object
1 property
1 required
DriverCoachAssignmentsPutDriverCoachAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
paginationResponse
object
Pagination parameters.
2 properties
2 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentRequestBody
object
Driver Assignment to be created
7 properties
2 required
VehiclesDriverAssignmentsObjectResponseBody
object
4 properties
2 required
GoaDriverTinyResponseResponseBody
object
A minified driver object. This object is only returned if the route is assigned to the driver.
3 properties
1 required
DriverCoachAssignmentsGetDriverCoachAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrainingAssignmentsPostTrainingAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
CarrierProposedAssignmentShippingDocs
string
Shipping Documents that this assignment will propose to the driver.
CarrierProposedAssignmentDriver_allOf
object
1 property
TrainingAssignmentsPostTrainingAssignmentsResponseBody
object
1 property
1 required
CarrierProposedAssignmentTrailers
array
Trailers that this assignment will propose to the driver.
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriversVehicleAssignmentsObjectResponseBody
object
5 properties
4 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrainingAssignmentsPostTrainingAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverVehicleAssignmentV2ObjectResponseBody
object
Object with driver assignment info and associated driver and vehicle info.
8 properties
4 required
V1TrailerAssignmentsResponse_allOf
object
1 property
CarrierProposedAssignmentAcceptedTime
string
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 pr…
DriversVehicleAssignmentsGetDriversVehicleAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrainingAssignmentsPostTrainingAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
TrainingAssignmentsPostTrainingAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
CarrierProposedAssignmentFirstSeenTime
string
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 p…
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
TrainingAssignmentsPostTrainingAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
trailerTinyResponse
object
A minified trailer object.
2 properties
V1TrailerAssignmentResponse
object
3 properties
TrainingAssignmentsPostTrainingAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
carrierProposedAssignmentDriverAllOf2ExternalIds
object
The [external IDs](https://developers.samsara.com/docs/external-ids) for the given object.
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentResponseBody
object
1 property
1 required
DriverCoachAssignmentsPutDriverCoachAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
CarrierProposedAssignmentActiveTime
string
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 form…
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
CoachAssignmentWithoutDriverExternalIdsResponseResponseBody
object
Driver coach assignment object.
4 properties
3 required
DriverAssignmentObjectResponseBody
object
5 properties
DriverCoachAssignmentsGetDriverCoachAssignmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
CreateCarrierProposedAssignmentRequest
object
New assignment for a driver.
6 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
vehicleTinyResponse
object
A minified vehicle object.
3 properties
TrainingAssignmentsGetTrainingAssignmentsStreamNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
CarrierProposedAssignmentTrailer
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrainingAssignmentsPostTrainingAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
ListCarrierProposedAssignmentResponse
object
A list of carrier-proposed assignments and pagination information.
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
CarrierProposedAssignmentRejectedTime
string
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 pr…
TrainingAssignmentsGetTrainingAssignmentsStreamTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
V1TrailerBase
object
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
driverTinyResponse
object
A minified driver object.
2 properties
PostDriverVehicleAssignmentsV2ResponseBodyResponseBody
object
Response after successfully submitting a Driver Assignment
1 property
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentResponseBody
object
2 properties
2 required
standardDeleteResponse
string
A successful DELETE response is a 204 with no content.
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
CarrierProposedAssignmentDriver
DriversVehicleAssignmentsGetDriversVehicleAssignmentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
CarrierProposedAssignmentVehicle
PostDriverVehicleAssignmentsV2RequestBodyMetadataRequestBody
object
Metadata about this driver assignment
1 property
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentRequestBody
object
Updated Driver Assignment details
7 properties
3 required
V1TrailerAssignmentsResponse
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrainingLearnerObjectResponseBody
object
Learner that is associated with the training assignment. Only driver learners are supported currently.
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsRequestBody
object
Driver assignments to be deleted
5 properties
1 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverVehicleAssignmentsV2CreateDriverVehicleAssignmentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
CarrierProposedAssignment
object
A carrier proposed assignment object
9 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
PatchDriverVehicleAssignmentsV2ResponseBodyResponseBody
object
Response after successfully updating a Driver Assignment
1 property
TrainingAssignmentsGetTrainingAssignmentsStreamResponseBody
object
2 properties
2 required
TrainingAssignmentsPostTrainingAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
TrainingAssignmentsPostTrainingAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
TrainingAssignmentsGetTrainingAssignmentsStreamInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsResponseBody
object
2 properties
2 required
PatchDriverVehicleAssignmentsV2RequestBodyMetadataRequestBody
object
Metadata about this driver assignment
1 property
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
VehicleAssignmentObjectResponseBody
object
5 properties
4 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DriverVehicleAssignmentsV2DeleteDriverVehicleAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverCoachAssignmentsPutDriverCoachAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
VehiclesDriverAssignmentsGetVehiclesDriverAssignmentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverWithExternalIdObjectResponseBody
object
A driver object with an id and map of external ids.
2 properties
1 required
DriverCoachAssignmentsPutDriverCoachAssignmentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
CoachAssignmentWithDriverExternalIdsResponseResponseBody
object
Driver coach assignment object.
4 properties
4 required
CarrierProposedAssignmentResponse
object
A carrier-proposed assignment response object.
1 property
1 required
DriversVehicleAssignmentsGetDriversVehicleAssignmentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
TrainingAssignmentResponseObjectResponseBody
object
Training Assignment response object.
16 properties
9 required
TrainingAssignmentsPostTrainingAssignmentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DriverVehicleAssignmentsV2UpdateDriverVehicleAssignmentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DriverVehicleAssignmentsV2GetDriverVehicleAssignmentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DriverCoachAssignmentsGetDriverCoachAssignmentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Samsara publishes across the network.