POST http:///fleet.roadprotect.co.il/api/v1/nomination/{nominationId}/redirect/digital
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| nominationId | number | The nominationId of the nomination to redirect |
Required |
The request body takes a complete DigitalRedirectionDto resource, containing the following writable properties:
{
"details": {
"acknowledgedFor": {},
"redirectionReason": "string"
},
"documentId": "number",
"to": "string"
}| Name | Type | Description | Additional |
|---|---|---|---|
| details | object | Optional | |
| details.acknowledgedFor | object |
{ [action: string]: boolean } |
|
| details.redirectionReason | string | ||
| documentId | number |
The documentId of a created document to save with the redirection |
Optional |
| to | string |
The target of the redirection Possible values are:
|
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 | Nomination |
| 400 | Bad Request
|