ECLD service 1.0.0

Announcement service for EMSWe Common Location Database (ECLD) changes.
Note: Due to tooling restrictions, Coordinates is only referenced once, in other sections it appears as 'Any'

## Operations

- ### SUB ecld-locations

  Operation IDsubscribe

  Accepts the following message:

  ecld_location
  Message IDecld_location
  object
  loCode
  required
  string
  5 characters

  Unique identifier of the location (concatenation of the 2-character ISO code of a country and a 3-character unique location identifier as defined by UNECE and/ or in SSN. SSN specific locodes in the form [Countrycode_888] (e.g.PT888) are used in the context of CLD to identify an unknown port in a given country

  Examples values:
  - "GRZTH"
  deactivated
  required
  boolean

  Specifies if the record is deactivated.

  Examples values:
  - false
  oneOf

  Details of the CLD location, null if the record is deactivated.

  object

  The details of a CLD location

  createdOn
  required
  integer
  [ -9223372036854776000 .. 9223372036854776000 ]

  Date and time of the creation of the location in the database. In milliseconds since the UNIX epoch.

  Examples values:
  - 1706869855000
  oneOf

  Date and time of the last update of the location in the database. In milliseconds since the UNIX epoch.

  Adheres to:
  integer
  [ -9223372036854776000 .. 9223372036854776000 ]
  Examples values:
  - 1706869855000
  Or to:
  null
  oneOf

  Official name of the location with diacritics. Equals to the Name with diacritics provided by UNECE for UNECE locations (e.g. Zákynthos for Locode GRZTH)

  Adheres to:
  string
  <= 50 characters
  Examples values:
  - "Zákynthos"
  Or to:
  null
  locationNameWithoutDiacritics
  required
  string
  <= 50 characters

  Name of the location without diacritics. Equals to the Name without diacritics provided by UNECE for UNECE locations (e.g. Zakynthos for Locode GRZTH).

  Examples values:
  - "Zakynthos"
  countryCode
  required
  string
  2 characters

  A code representing the country where the location is situated

  Examples values:
  - "GR"
  type
  required
  integer
  [ 0 .. 1 ]

  An indication whether the location is a United Nations Code for Trade and Transport Locations (UN/LOCODE), or whether the location is specific to SafeSeaNet. Possible values:
  0 (SSN)
  1 (UNECE)

  Examples values:
  - 1
  required
  object

  Location of the port

  latitude
  required
  number
  format: double[ -90 .. 90 ]decimal places <= 6

  Latitude in decimal degrees

  Examples values:
  - 37.7804
  longitude
  required
  number
  format: double[ -180 .. 180 ]decimal places <= 6

  Longitude in decimal degrees

  Examples values:
  - 20.9035

  Additional properties are allowed.

  required
  array<object>
  <= 8 unique items
  object

  UNECE defined location functions

  function
  required
  string
  1 characters

  Function number of the location (classifier code) as defined by UNECE. It is provided for UNECE locations. Possible values:
  0
  1
  2
  3
  4
  5
  6
  7
  8
  B

  Examples values:
  - "3"

  Additional properties are allowed.

  required
  array<object>
  <= 500 unique items
  object

  A facility in a port

  name
  required
  string
  [ 1 .. 1000 ] characters

  Name of a port, written as the port name is normally written.

  Examples values:
  - "Zakynthos"
  description
  required
  string
  [ 1 .. 2500 ] characters

  Port facility description in GISIS Maritime Security

  Examples values:
  - "Passenger Port"
  code
  required
  string
  <= 10 characters

  A code representing the port facility at the referenced port, composed by a locode followed by a port fcaility GISIS code separated by a dash (e.g. NLRTM-0406)

  Examples values:
  - "GRZTH-0001"
  oneOf

  Location of the port facility

  Adheres to:
  any
  Or to:
  null

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:
  null

  Additional properties are allowed.

  #### Examples

      {
        "loCode": "GRZTH",
        "deactivated": false,
        "details": {
          "createdOn": 1706869855000,
          "lastUpdatedOn": 1706869855000,
          "locationNameWithDiacritics": "Zákynthos",
          "locationNameWithoutDiacritics": "Zakynthos",
          "countryCode": "GR",
          "type": 1,
          "coordinates": {
            "latitude": 37.7804,
            "longitude": 20.9035
          },
          "UNECEFunctions": [
            {
              "function": "3"
            }
          ],
          "portFacilities": [
            {
              "name": "Zakynthos",
              "description": "Passenger Port",
              "code": "GRZTH-0001",
              "coordinates": {}
            }
          ]
        }
      }

  ###### This example has been generated automatically.

## Messages

- #1 ecld_location
  Message IDecld_location
  object
  loCode
  required
  string
  5 characters

  Unique identifier of the location (concatenation of the 2-character ISO code of a country and a 3-character unique location identifier as defined by UNECE and/ or in SSN. SSN specific locodes in the form [Countrycode_888] (e.g.PT888) are used in the context of CLD to identify an unknown port in a given country

  Examples values:
  - "GRZTH"
  deactivated
  required
  boolean

  Specifies if the record is deactivated.

  Examples values:
  - false
  oneOf

  Details of the CLD location, null if the record is deactivated.

  object

  The details of a CLD location

  createdOn
  required
  integer
  [ -9223372036854776000 .. 9223372036854776000 ]

  Date and time of the creation of the location in the database. In milliseconds since the UNIX epoch.

  Examples values:
  - 1706869855000
  oneOf

  Date and time of the last update of the location in the database. In milliseconds since the UNIX epoch.

  Adheres to:
  integer
  [ -9223372036854776000 .. 9223372036854776000 ]
  Examples values:
  - 1706869855000
  Or to:
  null
  oneOf

  Official name of the location with diacritics. Equals to the Name with diacritics provided by UNECE for UNECE locations (e.g. Zákynthos for Locode GRZTH)

  Adheres to:
  string
  <= 50 characters
  Examples values:
  - "Zákynthos"
  Or to:
  null
  locationNameWithoutDiacritics
  required
  string
  <= 50 characters

  Name of the location without diacritics. Equals to the Name without diacritics provided by UNECE for UNECE locations (e.g. Zakynthos for Locode GRZTH).

  Examples values:
  - "Zakynthos"
  countryCode
  required
  string
  2 characters

  A code representing the country where the location is situated

  Examples values:
  - "GR"
  type
  required
  integer
  [ 0 .. 1 ]

  An indication whether the location is a United Nations Code for Trade and Transport Locations (UN/LOCODE), or whether the location is specific to SafeSeaNet. Possible values:
  0 (SSN)
  1 (UNECE)

  Examples values:
  - 1
  required
  object

  Location of the port

  latitude
  required
  number
  format: double[ -90 .. 90 ]decimal places <= 6

  Latitude in decimal degrees

  Examples values:
  - 37.7804
  longitude
  required
  number
  format: double[ -180 .. 180 ]decimal places <= 6

  Longitude in decimal degrees

  Examples values:
  - 20.9035

  Additional properties are allowed.

  required
  array<object>
  <= 8 unique items
  object

  UNECE defined location functions

  function
  required
  string
  1 characters

  Function number of the location (classifier code) as defined by UNECE. It is provided for UNECE locations. Possible values:
  0
  1
  2
  3
  4
  5
  6
  7
  8
  B

  Examples values:
  - "3"

  Additional properties are allowed.

  required
  array<object>
  <= 500 unique items
  object

  A facility in a port

  name
  required
  string
  [ 1 .. 1000 ] characters

  Name of a port, written as the port name is normally written.

  Examples values:
  - "Zakynthos"
  description
  required
  string
  [ 1 .. 2500 ] characters

  Port facility description in GISIS Maritime Security

  Examples values:
  - "Passenger Port"
  code
  required
  string
  <= 10 characters

  A code representing the port facility at the referenced port, composed by a locode followed by a port fcaility GISIS code separated by a dash (e.g. NLRTM-0406)

  Examples values:
  - "GRZTH-0001"
  oneOf

  Location of the port facility

  Adheres to:
  any
  Or to:
  null

  Additional properties are allowed.

  Additional properties are allowed.

  Or to:
  null

  Additional properties are allowed.