Create an account on the system that represents a leasing company, vehicle user or hybrid account. We also need basic contact and address information
POST http:///fleet.roadprotect.co.il/api/v1/account
The request body takes a complete CreateAccountV1Dto resource, containing the following writable properties:
{
"city": "string",
"code": "string",
"contactFax": "string",
"contactName": "string",
"contactTelephone": "string",
"country": "string",
"identifier": "string",
"name": "string",
"postOfficeBox": "string",
"primaryContact": "string",
"proximity": "string",
"role": "string",
"streetName": "string",
"streetNumber": "string"
}
| Name | Type | Description | Additional |
|---|---|---|---|
| city | string | ||
| code | string | Optional | |
| contactFax | string |
The fax number of the primary contact for this account |
Optional |
| contactName | string |
The given name of the primary contact for this account |
Optional |
| contactTelephone | string |
The phone number of the primary contact for this account |
Optional |
| country | string | ||
| identifier | string |
The identifier or business registration of the account |
|
| name | string |
The name of the group / business / company |
|
| postOfficeBox | string | Optional | |
| primaryContact | string |
The email address of the primary contact for this account |
|
| proximity | string | Optional | |
| role | string |
The primary role of the account, whether it functions primarily as a vehicle owner [Owner], user [User] or both [Hybrid] Possible values are:
|
|
| streetName | string | Optional | |
| streetNumber | string | Optional |
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 | Account |
| 400 | Bad Request E117: No valid locations were provided, neither Postal nor Physical |
|
| 500 | Internal Server Error Database error. Failed to perform that action, please contact support. |