ECHD service 1.0.0

Announcement service for EMSWe Common Hazmat Database (ECHD) changes

## Operations

- ### SUB echd-hazmats

  Operation IDsubscribe

  Accepts the following message:

  HazmatItem
  Message IDHazmatItem
  object
  id
  required
  string
  <= 30 characters

  The id of the hazmat item as maintained in the CHD.

  Examples values:
  - "CHD123456789"
  editionType
  required
  string
  [ 1 .. 17 ] characters

  Code indicating whether the hazmat item is referred to in a mandatory or voluntary edition of the corresponding code.
  Note: Voluntary codes become mandatory on January the following year.
  Applicable values: VOLUNTARY, MANDATORY

  Examples values:
  - "MANDATORY"
  deleted
  required
  boolean

  Specifies if the record is deleted.

  Examples values:
  - false
  oneOf

  Details of the hazmat item, null if the record is deleted.

  object
  regulation
  required
  string
  3 characters

  Code specifying a dangerous goods regulatory instrument, such as IMDG, IBC, IGC, IMSBC, MARPOL.
  Values are mapped such as:
  IMDG -> IMD
  IBC and IBC_TPA -> ADY
  IGC -> ADZ
  IMSBC -> AEA
  Marpol Annex 1 -> AEB

  Examples values:
  - "IMD"
  editionType
  required
  string
  [ 1 .. 17 ] characters

  Code indicating whether the hazmat item is referred to in a mandatory or voluntary edition of the corresponding code.
  Note: Voluntary codes become mandatory on January the following year.
  Applicable values: VOLUNTARY, MANDATORY

  Examples values:
  - "MANDATORY"
  properShippingName
  required
  string
  [ 1 .. 512 ] characters

  The proper shipping name for goods under IMDG Code, or the product name for goods under IBC Code and IGC Code, or the bulk cargo shipping name for goods under IMSBC Code, or the name of oil for goods under Annex I to the MARPOL Convention.

  Examples values:
  - "NSECTICIDE GAS, TOXIC, FLAMMABLE, N.O.S."
  oneOf

  The hazard class code of the referenced dangerous goods according to the specified regulation. Possible values:
  1
  2
  3
  4
  5
  6
  7
  8
  9
  1.1
  1.2
  1.3
  1.4
  1.5
  1.6
  1.1A
  1.1B
  1.1C
  1.1D
  1.1E
  1.1F
  1.1G
  1.1J
  1.1L
  1.2B
  1.2C
  1.2D
  1.2E
  1.2F
  1.2G
  1.2H
  1.2J
  1.2K
  1.2L
  1.3C
  1.3F
  1.3G
  1.3H
  1.3J
  1.3K
  1.3L
  1.4B
  1.4C
  1.4D
  1.4E
  1.4F
  1.4G
  1.4S
  1.5D
  1.6N
  2.1
  2.2
  2.3
  4.1
  4.2
  4.3
  5.1
  5.2
  6.1
  6.2
  A
  A AND B
  B
  N.A.
  P
  S
  S/P

  Adheres to:
  string
  [ 1 .. 7 ] characters
  Examples values:
  - "5.1"
  Or to:
  null
  oneOf

  United Nations Dangerous Goods Identifier (UNDG) assigned by the UN Sub-Committee of Experts on the Transport of Dangerous Goods and shown in the IMO IMDG.

  Adheres to:
  string
  must match: d{4}4 characters
  Examples values:
  - "3087"
  Or to:
  null
  oneOf

  The packing group according to the UN Recommendations on the Transport of Dangerous Goods and IMO IMDG Code.
  Applicable values: I, II, III

  Adheres to:
  string
  [ 1 .. 3 ] characters
  Examples values:
  - "II"
  Or to:
  null
  required
  array<string>
  <= 5 items

  Any risk in addition to the class of the referenced dangerous goods according to the IMO IMDG Code. Possible values:
  1
  2
  3
  4
  5
  6
  7
  8
  9
  1.1
  1.2
  1.3
  1.4
  1.5
  1.6
  1.1A
  1.1B
  1.1C
  1.1D
  1.1E
  1.1F
  1.1G
  1.1J
  1.1L
  1.2B
  1.2C
  1.2D
  1.2E
  1.2F
  1.2G
  1.2H
  1.2J
  1.2K
  1.2L
  1.3C
  1.3F
  1.3G
  1.3H
  1.3J
  1.3K
  1.3L
  1.4B
  1.4C
  1.4D
  1.4E
  1.4F
  1.4G
  1.4S
  1.5D
  1.6N
  2.1
  2.2
  2.3
  4.1
  4.2
  4.3
  5.1
  5.2
  6.1
  6.2
  A
  A AND B
  B
  N.A.
  P
  S
  S/P

  Examples values:
  - [6.1,8]
  Items:
  string
  [ 1 .. 7 ] characters
  Examples values:
  - "6.1"
  oneOf

  A code representing the type of marine pollutant properties for the referenced dangerous goods from the IMO IMDG Code or IBC Code / MARPOL Convention.
  Applicable values:
  O - Other Substances
  P - Marine pollutant
  X - Category X
  Y - Category Y
  Z - Category Z

  Adheres to:
  string
  [ 1 .. 3 ] characters
  Examples values:
  - "O"
  Or to:
  null
  required
  array<string>
  <= 3 items

  The emergency schedule identified in the IMO EmS Guide – Emergency Response Procedures for Ships Carrying Dangerous Goods.

  Examples values:
  - [F-A,F-D]
  Items:
  string
  [ 1 .. 6 ] characters
  Examples values:
  - "F-Z"
  oneOf

  A statement of any other information relevant to the characteristics or hazards of the referenced dangerous goods cargo item.

  Adheres to:
  string
  [ 1 .. 1024 ] characters
  Examples values:
  - "This product/cargo is not listed in a Code but is being carried on the basis of a tripartite agreement including agreed conditions between the flag State of the ship and the port States where the cargo is loaded and discharged"
  Or to:
  null
  oneOf

  The flashpoint of the referenced dangerous goods according to the IMO IMDG Code expressed in degrees Celsius.

  Adheres to:
  number
  format: double[ -237.15 .. 999999.99 ]decimal places <= 2
  Examples values:
  - 125.25
  Or to:
  null
  carriageMode
  required
  string
  [ 1 .. 17 ] characters

  A code indicating the mode of carriage of the dangerous goods.
  Applicable values: Packaged, Bulk

  Examples values:
  - "Bulk"
  oneOf

  A code indicating the type of product of the dangerous goods.
  Applicable values: Liquid, Solid, Gas

  Adheres to:
  string
  [ 1 .. 17 ] characters
  Examples values:
  - "Liquid"
  Or to:
  null
  oneOf

  A code indicating the type of liquid of the dangerous goods. Only applicable to liquid products.
  Applicable values: Chemicals or noxious, Oil

  Adheres to:
  string
  [ 1 .. 20 ] characters
  Examples values:
  - "Chemicals or noxious"
  Or to:
  null

  Additional properties are allowed.

  Or to:
  null

  Additional properties are allowed.

  #### Examples

      {
        "id": "CHD123456789",
        "editionType": "MANDATORY",
        "deleted": false,
        "details": {
          "regulation": "IMD",
          "editionType": "MANDATORY",
          "properShippingName": "NSECTICIDE GAS, TOXIC, FLAMMABLE, N.O.S.",
          "hazardClass": "5.1",
          "UNDGnumber": "3087",
          "packingGroup": "II",
          "subsidiaryRisk": [
            "6.1",
            "8"
          ],
          "marinePollutionType": "O",
          "emsNumber": [
            "F-A",
            "F-D"
          ],
          "additionalInformation": "This product/cargo is not listed in a Code but is being carried on the basis of a tripartite agreement including agreed conditions between the flag State of the ship and the port States where the cargo is loaded and discharged",
          "flashPoint": 125.25,
          "carriageMode": "Bulk",
          "productType": "Liquid",
          "liquidType": "Chemicals or noxious"
        }
      }

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

## Messages

- #1 HazmatItem
  Message IDHazmatItem
  object
  id
  required
  string
  <= 30 characters

  The id of the hazmat item as maintained in the CHD.

  Examples values:
  - "CHD123456789"
  editionType
  required
  string
  [ 1 .. 17 ] characters

  Code indicating whether the hazmat item is referred to in a mandatory or voluntary edition of the corresponding code.
  Note: Voluntary codes become mandatory on January the following year.
  Applicable values: VOLUNTARY, MANDATORY

  Examples values:
  - "MANDATORY"
  deleted
  required
  boolean

  Specifies if the record is deleted.

  Examples values:
  - false
  oneOf

  Details of the hazmat item, null if the record is deleted.

  object
  regulation
  required
  string
  3 characters

  Code specifying a dangerous goods regulatory instrument, such as IMDG, IBC, IGC, IMSBC, MARPOL.
  Values are mapped such as:
  IMDG -> IMD
  IBC and IBC_TPA -> ADY
  IGC -> ADZ
  IMSBC -> AEA
  Marpol Annex 1 -> AEB

  Examples values:
  - "IMD"
  editionType
  required
  string
  [ 1 .. 17 ] characters

  Code indicating whether the hazmat item is referred to in a mandatory or voluntary edition of the corresponding code.
  Note: Voluntary codes become mandatory on January the following year.
  Applicable values: VOLUNTARY, MANDATORY

  Examples values:
  - "MANDATORY"
  properShippingName
  required
  string
  [ 1 .. 512 ] characters

  The proper shipping name for goods under IMDG Code, or the product name for goods under IBC Code and IGC Code, or the bulk cargo shipping name for goods under IMSBC Code, or the name of oil for goods under Annex I to the MARPOL Convention.

  Examples values:
  - "NSECTICIDE GAS, TOXIC, FLAMMABLE, N.O.S."
  oneOf

  The hazard class code of the referenced dangerous goods according to the specified regulation. Possible values:
  1
  2
  3
  4
  5
  6
  7
  8
  9
  1.1
  1.2
  1.3
  1.4
  1.5
  1.6
  1.1A
  1.1B
  1.1C
  1.1D
  1.1E
  1.1F
  1.1G
  1.1J
  1.1L
  1.2B
  1.2C
  1.2D
  1.2E
  1.2F
  1.2G
  1.2H
  1.2J
  1.2K
  1.2L
  1.3C
  1.3F
  1.3G
  1.3H
  1.3J
  1.3K
  1.3L
  1.4B
  1.4C
  1.4D
  1.4E
  1.4F
  1.4G
  1.4S
  1.5D
  1.6N
  2.1
  2.2
  2.3
  4.1
  4.2
  4.3
  5.1
  5.2
  6.1
  6.2
  A
  A AND B
  B
  N.A.
  P
  S
  S/P

  Adheres to:
  string
  [ 1 .. 7 ] characters
  Examples values:
  - "5.1"
  Or to:
  null
  oneOf

  United Nations Dangerous Goods Identifier (UNDG) assigned by the UN Sub-Committee of Experts on the Transport of Dangerous Goods and shown in the IMO IMDG.

  Adheres to:
  string
  must match: d{4}4 characters
  Examples values:
  - "3087"
  Or to:
  null
  oneOf

  The packing group according to the UN Recommendations on the Transport of Dangerous Goods and IMO IMDG Code.
  Applicable values: I, II, III

  Adheres to:
  string
  [ 1 .. 3 ] characters
  Examples values:
  - "II"
  Or to:
  null
  required
  array<string>
  <= 5 items

  Any risk in addition to the class of the referenced dangerous goods according to the IMO IMDG Code. Possible values:
  1
  2
  3
  4
  5
  6
  7
  8
  9
  1.1
  1.2
  1.3
  1.4
  1.5
  1.6
  1.1A
  1.1B
  1.1C
  1.1D
  1.1E
  1.1F
  1.1G
  1.1J
  1.1L
  1.2B
  1.2C
  1.2D
  1.2E
  1.2F
  1.2G
  1.2H
  1.2J
  1.2K
  1.2L
  1.3C
  1.3F
  1.3G
  1.3H
  1.3J
  1.3K
  1.3L
  1.4B
  1.4C
  1.4D
  1.4E
  1.4F
  1.4G
  1.4S
  1.5D
  1.6N
  2.1
  2.2
  2.3
  4.1
  4.2
  4.3
  5.1
  5.2
  6.1
  6.2
  A
  A AND B
  B
  N.A.
  P
  S
  S/P

  Examples values:
  - [6.1,8]
  Items:
  string
  [ 1 .. 7 ] characters
  Examples values:
  - "6.1"
  oneOf

  A code representing the type of marine pollutant properties for the referenced dangerous goods from the IMO IMDG Code or IBC Code / MARPOL Convention.
  Applicable values:
  O - Other Substances
  P - Marine pollutant
  X - Category X
  Y - Category Y
  Z - Category Z

  Adheres to:
  string
  [ 1 .. 3 ] characters
  Examples values:
  - "O"
  Or to:
  null
  required
  array<string>
  <= 3 items

  The emergency schedule identified in the IMO EmS Guide – Emergency Response Procedures for Ships Carrying Dangerous Goods.

  Examples values:
  - [F-A,F-D]
  Items:
  string
  [ 1 .. 6 ] characters
  Examples values:
  - "F-Z"
  oneOf

  A statement of any other information relevant to the characteristics or hazards of the referenced dangerous goods cargo item.

  Adheres to:
  string
  [ 1 .. 1024 ] characters
  Examples values:
  - "This product/cargo is not listed in a Code but is being carried on the basis of a tripartite agreement including agreed conditions between the flag State of the ship and the port States where the cargo is loaded and discharged"
  Or to:
  null
  oneOf

  The flashpoint of the referenced dangerous goods according to the IMO IMDG Code expressed in degrees Celsius.

  Adheres to:
  number
  format: double[ -237.15 .. 999999.99 ]decimal places <= 2
  Examples values:
  - 125.25
  Or to:
  null
  carriageMode
  required
  string
  [ 1 .. 17 ] characters

  A code indicating the mode of carriage of the dangerous goods.
  Applicable values: Packaged, Bulk

  Examples values:
  - "Bulk"
  oneOf

  A code indicating the type of product of the dangerous goods.
  Applicable values: Liquid, Solid, Gas

  Adheres to:
  string
  [ 1 .. 17 ] characters
  Examples values:
  - "Liquid"
  Or to:
  null
  oneOf

  A code indicating the type of liquid of the dangerous goods. Only applicable to liquid products.
  Applicable values: Chemicals or noxious, Oil

  Adheres to:
  string
  [ 1 .. 20 ] characters
  Examples values:
  - "Chemicals or noxious"
  Or to:
  null

  Additional properties are allowed.

  Or to:
  null

  Additional properties are allowed.