User License resource

Methods

  • post - Add license document to an existing user
  • get - Get a user's license document
  • put - Update license document for an existing user

Resource

{
    "country": {
        "code": "string",
        "name": "string"
    },
    "number": "string",
    "type": {
        "id": "integer",
        "name": "string"
    },
    "year": "integer"
}

Properties

Name Type Description Additional
country object

Country information.
country.code string

Country code

 Optional, read only.
country.name string

Country name

 Optional, read only.
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