Create document

Request

POST http:///fleet.roadprotect.co.il/api/v1/document

Form parameters

Parameter name Value Description Additional
file file
ocr boolean

Request body

The request body takes a complete CreateDocumentDto resource, containing the following writable properties:

{
    "fileDirectory": "string",
    "fileName": "string",
    "ocr": {
        "car": "string",
        "contract": "string",
        "customer": "string",
        "end": "string",
        "owner": "string",
        "start": "string"
    },
    "storageName": "string"
}

Properties

Name Type Description Additional
fileDirectory string
fileName string
ocr object OcrDetails
ocr.car string
ocr.contract string
ocr.customer string
ocr.end string
ocr.owner string
ocr.start string
storageName string

Authorisation

To authenticate your client integration please put your token in the header of your requests with the key Authorization, it should look like this:

Authorization: Bearer YOUR_TOKEN_HERE

Please keep your token secured. If your token is compromised, we can issue a new token for you.

This request requires the use of one of following authorisation methods: API key .

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
201 Created Document
400 Bad Request
  • E025: Received an error from the Contract OCR
  • E043: Failed to add document
500 Internal Server Error

E122: The CreateDocumentDto does not have a fileName: CreateDocumentDto