The identity and technical contract details declared by the specification.
DocumentsDeleteDocumentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
multipleChoiceFieldTypeMetaDataObjectResponseBody
object
1 property
DocumentsGetDocumentsNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DocumentTypesGetDocumentTypesBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
standardErrorResponse
object
Error response
2 properties
scannedDocumentValueObjectRequestBody
object
2 properties
scannedDocumentValueObjectResponseBody
object
2 properties
DocumentTypesGetDocumentTypesBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DocumentPdfGenerationResponse_data
object
2 properties
GoaVehicleTinyResponseResponseBody
object
A minified vehicle object. This object is only returned if the route is assigned to the vehicle.
3 properties
DocumentsDeleteDocumentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
dateTimeValueObjectRequestBody
object
The value of a date time field. Only present for date time fields.
1 property
DocumentsPostDocumentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DocumentsGetDocumentsInternalServerErrorResponseBody
object
An internal server error occurred
2 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
DocumentsGetDocumentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
multipleChoiceValueObjectResponseBody
object
2 properties
DocumentsDeleteDocumentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
signatureValueObjectRequestBody
object
The value of a signature field. Only present for signature fields.
4 properties
DocumentsGetDocumentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DocumentsGetDocumentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
GoaRouteStopTinyResponseResponseBody
object
A minified route stop object
3 properties
DocumentsGetDocumentsTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DocumentsDeleteDocumentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DocumentsGetDocumentsResponseBody
object
2 properties
2 required
GoaPaginationResponseResponseBody
object
Pagination parameters.
2 properties
2 required
DocumentsDeleteDocumentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DocumentPdfGenerationResponse
object
Identifies a PDF generation job.
1 property
DocumentsGetDocumentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DocumentsDeleteDocumentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
documentResponseObjectResponseBody
object
A single document.
13 properties
6 required
dateTimeValueObjectResponseBody
object
The value of a date time field. Only present for date time fields.
1 property
DocumentsGetDocumentResponseBody
object
1 property
DocumentsGetDocumentsBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
GoaRouteTinyResponseResponseBody
object
A minified representation of a single route.
3 properties
1 required
DocumentsGetDocumentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DocumentsPostDocumentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DocumentsPostDocumentMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
GoaDocumentTypeTinyResponseResponseBody
object
A minified document type object
2 properties
DocumentsGetDocumentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DocumentsDeleteDocumentNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DocumentsPostDocumentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DocumentTypesGetDocumentTypesUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DocumentsPostDocumentRequestBody
object
8 properties
2 required
DocumentPdfQueryResponse_data
object
6 properties
signatureFieldTypeMetaDataObjectResponseBody
object
The signature field metadata.
1 property
DocumentsPostDocumentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DocumentsPostDocumentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
barcodeValueObjectRequestBody
object
2 properties
fieldObjectValueRequestBody
object
The value of the document field. The shape of value depends on the type.
8 properties
DocumentsPostDocumentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DocumentsPostDocumentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DocumentsGetDocumentsNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
DocumentsPostDocumentNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
multipleChoiceValueObjectRequestBody
object
2 properties
DocumentTypesGetDocumentTypesResponseBody
object
2 properties
2 required
DocumentsGetDocumentsGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
fieldObjectValueResponseBody
object
The value of the document field. The shape of value depends on the type.
8 properties
DocumentPdfQueryResponse
object
A PDF of a document
1 property
DocumentTypesGetDocumentTypesNotFoundErrorResponseBody
object
Resource not found
2 properties
2 required
photoValueObjectResponseBody
object
2 properties
DocumentsPostDocumentResponseBody
object
1 property
DocumentTypesGetDocumentTypesGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
DocumentsGetDocumentsBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
DocumentTypesGetDocumentTypesServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
DocumentsPostDocumentGatewayTimeoutErrorResponseBody
object
Gateway timeout
2 properties
2 required
numberFieldTypeMetaDataObjectResponseBody
object
The number field metadata.
1 property
DocumentTypesGetDocumentTypesInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
DocumentsDeleteDocumentBadGatewayErrorResponseBody
object
Bad Gateway
2 properties
2 required
DocumentsGetDocumentsMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DocumentTypesGetDocumentTypesMethodNotAllowedErrorResponseBody
object
Method not allowed
2 properties
2 required
DocumentsGetDocumentBadRequestErrorResponseBody
object
Bad Request parameters
2 properties
2 required
barcodeValueObjectResponseBody
object
2 properties
DocumentsGetDocumentsServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
fieldObjectPostRequestBody
object
3 properties
2 required
DocumentTypesGetDocumentTypesTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
fieldObjectResponseBody
object
3 properties
3 required
DocumentsGetDocumentsUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
DocumentsGetDocumentInternalServerErrorResponseBody
object
An internal server error occurred
2 properties
2 required
signatureValueObjectResponseBody
object
The value of a signature field. Only present for signature fields.
4 properties
getDocumentTypeResponseObjectResponseBody
object
5 properties
DocumentsGetDocumentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DocumentsDeleteDocumentUnauthorizedErrorResponseBody
object
Unauthorized
2 properties
2 required
fieldTypesObjectResponseBody
object
6 properties
3 required
DocumentTypesGetDocumentTypesNotImplementedErrorResponseBody
object
Requested endpoint is not yet implemented
2 properties
2 required
DocumentsDeleteDocumentTooManyRequestsErrorResponseBody
object
Too many requests
2 properties
2 required
DocumentPdfGenerationRequest
object
Identifies a document for PDF generation.
1 property
1 required
photoValueObjectRequestBody
object
2 properties
conditionalFieldSectionObjectResponseBody
object
4 properties
DocumentsGetDocumentServiceUnavailableErrorResponseBody
object
Service unavailable
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Samsara publishes across the network.
