Add license document to an existing user
Request
POST https://api.digital-nautic.com/v3/users/{userId}/license
Path parameters
| Parameter name | Value | Description | Additional |
|---|---|---|---|
| userId | integer | pass a user id to add the user license information. |
Required |
Request body
The request body takes a complete User License resource, containing the following writable properties:
{
"country": {},
"number": "string",
"type": {
"id": "integer",
"name": "string"
},
"year": "integer"
}Properties
| Name | Type | Description | Additional |
|---|---|---|---|
| country | object |
Country information. |
|
| number | string |
Number mentioned on the boat license document |
|
| type | object |
Boating licenses have multiple types / tiers. This represents the type of license used by a User. |
|
| type.id | integer |
Element ID |
|
| type.name | string |
Name of the boat license |
|
| year | integer |
Year of obtention mentioned on the boat license document |
Response
The following HTTP status codes may be returned, optionally with a response resource.
| Status code | Description | Resource |
|---|---|---|
| 200 | OK item created |
User License |
| 400 | Bad Request invalid input, object invalid |
|
| 401 | Unauthorized authorization information is missing or invalid. |
|
| 409 | Conflict an existing item already exists |