POST http:///fleet.roadprotect.co.il/api/v1/ownership-contract
The request body takes a complete CreateOwnershipContractDto resource, containing the following writable properties:
{
"document": "number",
"endDate": "string",
"owner": "string",
"reference": "string",
"startDate": "string",
"vehicle": {}
}
| Name | Type | Description | Additional |
|---|---|---|---|
| document | number |
The documentId for the license document |
Optional |
| endDate | string |
The ownership end date |
Optional |
| owner | string |
The lease contract owner BRN |
|
| reference | string |
An optional reference Id for linking to batch file upload or your system Id |
Optional |
| startDate | string |
The ownership start date |
|
| vehicle | object |
The vehicle registration |
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
.
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 201 | Created | OwnershipContract |
| 400 | Bad Request
|
|
| 500 | Internal Server Error Failed to create ownership contract, please contact the developers. |