Harbour resource

Methods

  • get - Get harbour
  • get - List harbours

Resource

{
    "city": {
        "administrativeAreaLevel2": {
            "administrativeAreaLevel1": {
                "country": {
                    "code": "string",
                    "name": "string"
                },
                "id": "integer",
                "name": "string"
            },
            "id": "integer",
            "name": "string"
        },
        "id": "integer",
        "latitude": "number",
        "longitude": "number",
        "name": "string",
        "navigationArea": {
            "country": {
                "code": "string",
                "name": "string"
            },
            "id": "integer",
            "name": "string"
        },
        "postalCode": "string"
    },
    "id": "integer",
    "latitude": "number",
    "longitude": "number",
    "name": "string"
}

Properties

Name Type Description Additional
city object Optional, read only.
city.administrativeAreaLevel2 object Optional, read only.
city.administrativeAreaLevel2.administrativeAreaLevel1 object Optional, read only.
city.administrativeAreaLevel2.administrativeAreaLevel1.country object Optional, read only.
city.administrativeAreaLevel2.administrativeAreaLevel1.country.code string

Country code

 Optional, read only.
city.administrativeAreaLevel2.administrativeAreaLevel1.country.name string

Country name

 Optional, read only.
city.administrativeAreaLevel2.administrativeAreaLevel1.id integer

Administrative area level 1 ID

 Optional, read only.
city.administrativeAreaLevel2.administrativeAreaLevel1.name string

Administrative area level 1 name

 Optional, read only.
city.administrativeAreaLevel2.id integer

Administrative area level 2 ID

 Optional, read only.
city.administrativeAreaLevel2.name string

Administrative area level 2 name

 Optional, read only.
city.id integer

City ID

 Optional, read only.
city.latitude number

Geographical latitude of the city position

 Optional, read only.
city.longitude number

Geographical longitude of the city position

 Optional, read only.
city.name string

City name

 Optional, read only.
city.navigationArea object Optional, read only.
city.navigationArea.country object Optional, read only.
city.navigationArea.country.code string

Country code

 Optional, read only.
city.navigationArea.country.name string

Country name

 Optional, read only.
city.navigationArea.id integer

Navigation area ID

 Optional, read only.
city.navigationArea.name string

Navigation area name

 Optional, read only.
city.postalCode string

City postal code

 Optional, read only.
id integer

Harbour ID

 Optional, read only.
latitude number

Geographical latitude of the harbour position

 Optional, read only.
longitude number

Geographical longitude of the harbour position

 Optional, read only.
name string

Harbour name

 Optional, read only.