System Interface Guide - emsa.europa.eu€¦ · System Interface Guide Version: 4.0 15/07/2016 2 of...

EUROPEAN COMMISSION

EUROPEAN MARITIME SAFETY AGENCY

Cais Do Sodré 1249-206 Lisbon, Portugal

System Interface Guide

CHD

Document version: 4.0

Document release date: 15/07/2016

XSD version: 1.0

XSD release date: 15/07/2016

CHD System Interface Guide

Version: 4.0 15/07/2016

2 of 41

DOCUMENT APPROVAL

NAME DATE SIGNATURE

Prepared by: ED Project team 15.07.2016

Checked by: ED Project team 15.07.2016

Quality control by: G. Vallianatos 15.07.2016

Approved by: N. Tsopelas 15.07.2016

DISTRIBUTION LIST

COMPANY NAME FUNCTION FOR INFO / APPROVAL

EMSA EMSA Project Team Approval

ED ED Project Team Info

CHANGE CONTROL HISTORY

VERSION DATE AUTHOR DESCRIPTION

1.0 08.02.2016 European Dynamics SA Submitted to EMSA for review.

1.0 (EMSA review)

11.02.2016 EMSA EMSA feedback.

2.0 29.02.2016 European Dynamics SA Submitted to EMSA for review.

2.0 (EMSA review)


3.0 23.03.2016 European Dynamics SA Addressing EMSA’s comments and points discussed during TC of 15/03/2016.

3.0 (EMSA review)


4.0 15.07.2016 European Dynamics SA Addressing EMSA’s comments and all points discussed the previous months.


Version: 4.0 15/07/2016

3 of 41

TABLE OF CONTENTS

1 INTRODUCTION .................................................................................................. 4

1.1 DOCUMENT OVERVIEW ........................................................................................... 4 1.2 SCOPE .............................................................................................................. 4 1.3 AUTHENTICATION AND AUTHORIZATION OF SYSTEM USERS ................................................. 4 1.4 REFERENCE AND APPLICABLE DOCUMENTS ..................................................................... 4

1.4.1 Reference documents .................................................................................. 4 1.5 ABBREVIATIONS AND ACRONYMS................................................................................ 4

2 SYSTEM INTERFACES .......................................................................................... 6

2.1 SERVICES OVERVIEW ............................................................................................. 6 2.1.1 Hazmat items request mechanism ................................................................. 7 2.1.2 Hazmat items updates subscription mechanism .............................................. 9 2.1.3 Hazmat updates push mechanism ................................................................ 11

2.2 HAZMAT REQUESTOR INTERFACES ............................................................................. 13 2.3 HAZMAT UPDATES SUBSCRIBER INTERFACE .................................................................. 13 2.4 HAZMAT UPDATES ANNOUNCEMENT INTERFACE ............................................................. 14

3 HAZMAT EXCHANGE .......................................................................................... 15

3.1 REQUEST LIST OF HAZMAT ITEMS FROM CHD................................................................ 15 3.1.1 Introduction .............................................................................................. 15 3.1.2 Message flow ............................................................................................. 15 3.1.3 SYS2CHD_Hazmat_Req.xml message ........................................................... 15 3.1.4 CHD_Receipt.xml message .......................................................................... 18 3.1.5 CHD2SYS_Hazmat_Res.xml message ........................................................... 20

3.2 SUBSCRIBE TO CHD FOR UPDATES OF HAZMAT ITEMS...................................................... 22 3.2.1 Introduction .............................................................................................. 22 3.2.2 Message flow ............................................................................................. 22 3.2.3 SYS2CHD_Hazmat_Updates_Sub.xml message .............................................. 23

3.3 PUSH UPDATES OF HAZMAT ITEMS TO SUBSCRIBER ......................................................... 24 3.3.1 Introduction .............................................................................................. 24 3.3.2 Message flow ............................................................................................. 24 3.3.3 CHD2SYS_Hazmat_Updates_Ann.xml message .............................................. 24

ANNEX A - ATTRIBUTES AND ELEMENTS DEFINITIONS ........................................ 28

ANNEX B - DESCRIPTION OF WEB-SERVICES ...................................................... 35


Version: 4.0 15/07/2016

4 of 41

1 INTRODUCTION

1.1 Document overview

This document is the Central Hazmat Database application (CHD) System Interface Guide for

external systems and/or for systems integrated into the SSN Ecosystem. It describes all

technical aspects for any system to interact with CHD concerning the exchange of Hazmat

items.

1.2 Scope

This document defines the general requirements of the interfaces between an external

application and the CHD application with the scope of exchanging XML messages concerning:

The request and retrieval of a list of Hazmat items stored in the CHD by an external

application

The subscription of an external system to the “push” service of Hazmat items updates,

provided by the CHD

The CHD “push” service that will announce updates of Hazmat items to existing

subscribers

1.3 Authentication and authorization of system users

According to current practices followed for all the EMSA systems a two way SSL will be

established and certificates will be used by both ends. In terms of authorisation and EMSA’s

Identity Management system (IdM), all the system accesing CHD ill be granted exactly the

same role ebabling them to send requests and/ or subscribe to CHD.

This document mentions in various sections that system users need to be part of EMSA’s IdM

and also have the appropriate role. The preceding statement should be always read with

regard to the clarifications provided in this section.

1.4 Reference and Applicable documents

1.4.1 Reference documents

Id Reference Title Version

R1 CHD_MAR-

CIS_tech_specs

Annex A- MODULE1_CHD and

MARCIS2vfinal.pdf -

1.5 Abbreviations and acronyms

A list of the principal abbreviations and acronyms used in the document is provided here for a

better understanding of this document.

Abbreviation Definition

CHD Central Hazmat Database

EMSA European Maritime Safety Agency

IMO International Maritime Organisation


Version: 4.0 15/07/2016

5 of 41

Abbreviation Definition

SYS2CHD Used to indicate an external system or a system integrated in SSN

as the origin and CHD as the recipient of a message.

N/A Not Applicable or Not Available

SOAP Simple Object Access Protocol

CHD2SYS Used to indicate CHD as the origin and an external system or a

system integrated in SSN as the recipient of a message.

URL Unified Resource Locator

WSDL Web Service Definition Language

XML eXtensible Markup Language

VTMIS

Directive

Directive 2002/59/EC of the European Parliament and of the

Council of 27 June 2002 establishing a Community vessel traffic

information system and repealing Council Directive 93/75/EEC


Version: 4.0 15/07/2016

6 of 41

2 SYSTEM INTERFACES

2.1 Services Overview

The CHD is a new application in the EMSA ecosystem. It is based on the list of Hazmat items

which are to be notified in accordance with VTMIS Directive. The CHD should serve the needs

of industry stakeholders, reporting parties, relevant MS authorities, and emergency services

of the MS and other EMSA services. The CHD can be used as reference and verification tool

during the Hazmat reporting process both at national and central level. The CHD is made

available to the users via EMSA maritime applications portal (MAP), a public site, a REST

system-to-system interface and a SOAP system-to-system interface.

Regarding the system-to-system interfaces, CHD will define the communication interfaces for

the following sets of functionality:

Hazmat items request mechanism: External systems and systems integrated in SSN

ecosystem, listed in the CMC (IdM) as system users of the CHD application (having the

CHD_USER role) (see important notes of section 1.3) can request and receive in XML,

via a web service, one or more Hazmat items listed in the on-line version of CHD. The

request message can specify the criteria for the retrieval of Hazmat items. The Hazmat

items provided by the CHD will contain only the data attributes listed in the Appendix

A, section I of CHD_MAR-CIS_tech_specs [R1] document. The implementation of this

mechanism is asynchronous, following the common practice utilized by most services

in the SSN ecosystem.

Hazmat items updates subscription mechanism: External systems listed in the CMC

(IdM) as system users of the CHD application (having the CHD_USER role) (see

important notes of section 1.3) can subscribe to an update service in order to receive

at cut-off date/time the modifications on Hazmat items in the central on-line version of

CHD. The systems interested in receiving Hazmat items updates should invoke the

subscription web service. In their subscription request, the systems must provide a

service URL on their end that should be invoked by CHD when changes need to be

pushed. This mechanism can also be utilized in order to update subscription details or

unsubscribe to Hazmat updates announcements.

Hazmat updates push mechanism: Upon each cut-off date/time CHD prepares an XML

file which contains the updates on the Hazmat items. CHD fetches from its database

the list of subscribed systems and for each system, it invokes the URL specified in the

respective system subscription request (the URL is stored in its database following a

successful subscription request) and submits the XML file which contains the changes.

CHD keeps a record in its database for each system with the outcome of the push, i.e.

if the update message was successfully received or not (e.g. due to unavailability). It

should be noted that the pushing mechanism will be also executed immediately after a

successful subscription request by an external system in order to initialize the remote

dataset to the current on-line version of CHD.

Two sets of services, each one based on a different architecture are implemented by CHD.

The first set utilizes XML messages exchange over HTTP and the second is SOAP based. The

two sets of services are completely independent, with the exception that only one

subscription (i.e. either SOAP or REST) is allowed per external system, as described in ANNEX

B. Consequently, for the services that will be hosted in the external system’s end, the

implementation of one architecture (i.e. XML over HTTP or SOAP) is enough, in order to

achieve full functionality.

The way a MS system will pass the callback URL is also described in ANNEX B - DESCRIPTION

OF WEB-SERVICES and depends on the protocol to be utilised (SOAP or REST).


Version: 4.0 15/07/2016

7 of 41

2.1.1 Hazmat items request mechanism

The CHD Hazmat request mechanism is used by external systems and other systems

integrated in the SSN ecosystem in order to retrieve a list of Hazmat items existing in the

CHD database. The message flow is as follows:

The message exchange flow is described in the following table:

Step Action

1 The requestor prepares the SYS2CHD_Hazmat_Req XML message that may

contain the criteria for the retrieval of Hazmat items existing in CHD and

sends it to CHD

The criteria fields specified in the SYS2CHD_Hazmat_Req XML

message may all be empty; in which case, the CHD will return to the

requestor all Hazmat items in its database.


Version: 4.0 15/07/2016

8 of 41

2 The CHD validates the received SYS2CHD_Hazmat_Req XML message.

If well-formatted (XML compliant) and valid (compliant to

corresponding XSD), a CHD_Receipt message with StatusCode=’OK’ is

sent asynchronously by CHD. Subsequently, the CHD prepares the

response message and sends it back to the requestor asynchronously,

invoking the response service implemented by the external system.

Specifically, the CHD performs a search in the on-line version of the

dataset, based on the criteria specified in the requestor message and

prepares a CHD2SYS_Hazmat_Res response message. The response

contains the retrieved Hazmat items. In case no Hazmat items match

the criteria of the external system request, an empty Hazmat items

list will be submitted to the external systems response service by

CHD.

Important note:

In the next release of the application, the CHD_Receipt will be

removed from the message flow of CHD S2S request/ response

interfaces;

In case the client submits invalid input to the server, the

errors will be reported within the actual asynchronous

response (i.e. CHD2SYS_Hazmat_Res.xml), using the same

attributes as the ones currently used in the CHD_Receipt, i.e.

utilizing the ‘statusCode’ and ‘statusMessage’ attributes.

Effectively, in case of an invalid request, the Header will be

only included (with the statusCode and statusMessage) and

the Body part of the CHD2SYS_Hazmat_Res.xml response will

remain empty.

In case the SYS2CHD_Hazmat_Req XML message is invalid or any

problem during the processing of the request, it sends back to the

requestor the CHD_Receipt XML message, synchronously, with a

negative status code as response.

Note:

Refer to the ANNEX B - DESCRIPTION OF WEB-SERVICES for a description of

the mechanism to be utilized by the external system in order to pass the

callback url (i.e. the url where the response to a request will be submitted by

CHD), in case of SOAP and XML over HTTP architectures.

3 The requestor system should validate the received CHD2SYS_Hazmat_Res

XML message and process it.

2.1.1.1Business rules

Business rule 1

The Hazmat data returned by CHD to a system in a response message in the context of

Hazmat items request mechanism include only the fields specified in Appendix A, Section 1 of

CHD_MAR-CIS_tech_specs [R1]. The additional fields stored per IMO code, as per Appendix A

- Section II, with MAR-CIS 2 relevance, are not in-scope for this service.


Version: 4.0 15/07/2016

9 of 41

Business rule 2

The data returned by CHD to a system in the context of the Hazmat items requestor

interface, include only the Hazmat items that exist in the current on-line version of the CHD.

The data included in the working and target versions of CHD dataset are out of the scope of

this service.

Business rule 3 (see important notes of section 1.3)

The systems that will use the Hazmat items requestor interface of CHD must have a valid

user account in the CMC (IdM) in order to access the service. Specifically, each system is

authenticated with each request to CHD. Authorization is also implemented for each provided

service. The role that must be assigned to external systems for accessing this service is the

following:

CHD_USER: External systems (listed in the CMC (IdM) as system users of the CHD

application) assigned to this role can request and receive in XML, via a web service,

one or more Hazmat items listed in the on-line version of the CHD, based on

submitted criteria.

Business rule 4

In case no criteria are submitted by the requestor within a request in the context of the

Hazmat items request mechanism, the CHD will return all the Hazmat items in its database,

applying the Business rule 1 mentioned above.

Business rule 5

In case of unavailability of the external system, the CHD performs 3 retries at predefined

configurable intervals (e.g. every 10’’). If all retries fail, the CHD sends an e-mail to the e-

mail address specified in the external system’s request. The message contains details on the

failure.

2.1.2 Hazmat items updates subscription mechanism

The CHD Hazmat updates subscription mechanism is used by external systems and other

systems integrated in the SSN ecosystem in order to subscribe to updates of the on-line

version of the CHD dataset. The message flow is as follows:


Version: 4.0 15/07/2016

10 of 41


Step Action

1 The external system prepares the SYS2CHD_Hazmat_Updates_Sub XML

message in order to subscribe or update existing subscription or unsubscribe

to the updates push service of CHD and sends it to CHD.

2 The CHD validates that the received SYS2CHD_Hazmat_Updates_Sub XML

message is well-formatted (XML compliant) and valid (compliant to

corresponding XSD) and

If valid, the CHD processes it further and updates its database based

on the request, i.e. stores the new subscription, updates an existing

subscription or unsubscribes the requestor system. Subsequently,

CHD prepares a CHD_receipt message with StatusCode “OK” and

sends it back to the requestor system.

If invalid, or any other error occurs during processing, the CHD sends

back to the requestor a CHD_Receipt message with a negative status

code as response.



The systems that will use the Hazmat items updates subscription mechanism of CHD must

have a valid user account in the CMC (IdM) in order to access the service. Specifically, each

system is authenticated in each subscription request to CHD. Authorization is also

implemented for each provided service. The role that will be assigned to external systems for

accessing this service is the following:

CHD_USER: External systems (listed in the CMC (IdM) as system users of the CHD

application) assigned to this role can subscribe and receive in XML via a web service,

the Hazmat items changed in the CHD on-line version upon their cut-off date/time.


Version: 4.0 15/07/2016

11 of 41

Business rule 2

Only one subscription is allowed per external system user account. Additional subscription

requests will be handled by CHD as updates or cancellations of the existing subscription for

the external system.

Business rule 3

An update of a specific subscription for an external system will not modify the log that is kept

in CHD database for the status of the external system’s dataset. Consequently, the external

system will not receive the full CHD dataset after a subscription update but only the updates

on its previous status (that is stored in CHD database). The preceding is also applicable for

expired subscriptions but not for cancelled. An external system should cancel its existing

subscription and request for a new one in order to receive the full CHD dataset (e.g. in order

to reinitialize its database).

2.1.3 Hazmat updates push mechanism

The CHD Hazmat updates announcement mechanism is used by CHD in order to push updates

in the on-line version of the CHD dataset to subscribers. The message flow is as follows:


Step Action


Version: 4.0 15/07/2016

12 of 41

1 The CHD scans periodically (e.g. every 3 hours) for new on-line versions of

the Hazmat dataset or for new subscriptions [i.e. subscribed external systems

with no DatasetVersionDate (for more info about DatasetVersionDate see

Annex A) and a dedicated flag stored in CHD database (e.g. ‘initialized’) set

to false].

In case of a new on-line version, the CHD fetches the list of subscriptions

stored in its database.

Note: The interval value (i.e. three hours) will be stored in a CHD property

file and could be updated by EMSA without the provision of new release. Only

a system restart will be required.

2 The CHD prepares the CHD2SYS_Hazmat_Updates_Ann XML message that

contains the updates on Hazmat items (i.e. created or updated Hazmat Items

and List of deleted Hazmat Items Ids) since the previous version of the CHD

on-line dataset that was accepted by the subscriber.

In case the subscription is new, the CHD2SYS_Hazmat_Updates_Ann XML

message contains all Hazmat items in the on-line version of CHD.

3 The CHD pushes the CHD2SYS_Hazmat_Updates_Ann XML message.


Business rule 1

The Hazmat data pushed by CHD to other systems in the context of the Hazmat updates

pushing mechanism include only the fields specified in Appendix A, Section 1 of CHD_MAR-

CIS_tech_specs [R1]. The additional fields stored per IMO code, as per appendix A-section II,

with MAR-CIS 2 relevance, are not in-scope for this service.

Business rule 2

In order to receive Hazmat items updates by the CHD updates pushing mechanism, the

external system must have previously been subscribed to the Hazmat items updates

subscription mechanism. Hence, an active subscription must exist in CHD for this system. A

previously active subscription endpoint will stop receiving updates on Hazmat items by this

mechanism as soon as the subscription is cancelled or ends.


Prior to sending the Hazmat updates XML to an external system, the CHD performs a check

against IdM and CMC that the subscribed system has a valid user account and is assigned the

CHD_USER role. In case the user has been removed from the IdM the CHD_USER role has

been removed from the user, the push of updates is cancelled and the subscription is

invalidated.

Business rule 4

In case of unavailability of the external system, the CHD performs 3 retries at predefined

configurable intervals (e.g. every 10’’). If all retries fail, the CHD sends an e-mail to the e-

mail address specified in the external system’s subscription. The message contains details on

the failure. The CHD will not perform any other attempt of pushing the updates to the

external system until the next online version is published.

Business rule 5


Version: 4.0 15/07/2016

13 of 41

The Hazmat updates pushing mechanism will be executed when a new on-line version of the

CHD dataset is available, as well as after the completion of a successful subscription request

by an external system in order to initialize the remote dataset to the current on-line version

of CHD.

Business rule 6

The Hazmat updates service identifies changes on Hazmat items between distinct versions of

the on-line dataset. The updates message and the list of changes included are specific for

each external system. CHD tracks and stores the creation date of the latest online version of

the CHD dataset that was pushed to an external system, based on the acknowledgement that

is sent by the external system to CHD upon each successful receipt of an updates message.

When a new on-line version of the Hazmat items dataset is identified by CHD, a new update

message will be pushed to each external system. The message will include the changes on

the CHD dataset between the latest successful push for the specific system and the current

on-line version.

2.2 Hazmat Requestor Interfaces

Two services will be implemented for this mechanism on the CHD end, namely, one based on

the SOAP architecture and another based on the REST architecture. One service must be

implemented by the external system in order to be capable of receiving the Hazmat items list

messages. The SOAP/REST request will be created by the external system and submitted to

the REST/SOAP service implemented by CHD. The SOAP/REST receipt and response

messages will be created by the CHD and sent to the external system utilizing the SOAP/REST

service implemented on the external system’s end. CHD supports both architectures, while

the external system should implement at least one of them. The two architectures will be fully

isolated; hence an external system that submits a request using the REST or SOAP service

will receive the response on the REST or SOAP service respectively, that must be

implemented on its end.

For the SOAP based services, both ends should be capable of processing SOAP 1.2 messages

over HTTP(S). For the REST architecture, both ends should be capable of handling HTTP(S)

requests and responses with XML body. For both interfaces, the messages exchanged are as

follows:

SYS2CHD_Hazmat_Req

CHD2SYS_Hazmat_Res

CHD_Receipt (Note: Not to be exchanged for request/ response in the final

release of the interface(

2.3 Hazmat Updates Subscriber Interface

Two interfaces will be implemented for this mechanism, namely, one based on the SOAP

architecture and the other based on the REST architecture. The SOAP/REST request will be

created and submitted by the external system and the SOAP/REST response will be created

and sent by the CHD. CHD supports both interfaces (SOAP and REST), while the external

system should implement at least one of them. For the SOAP based service, both ends should

be capable of processing SOAP 1.2 messages over HTTP(S). For the REST interface, both

ends should be capable of handling HTTP(S) requests and responses with XML body. For both

interfaces, the messages exchanged are as follows:

SYS2CHD_Hazmat_Updates_Sub

CHD_Receipt


Version: 4.0 15/07/2016

14 of 41

2.4 Hazmat Updates Announcement Interface

Two interfaces will be implemented for this mechanism, namely, one based on the SOAP

architecture and the other based on the REST architecture. The SOAP/REST request will be

created and submitted by the CHD and the SOAP/REST response will be created and sent by

the external system. CHD implements both interfaces, while the external system should

implement at least one of them. For the SOAP based service, both ends should be capable of

processing SOAP 1.2 messages over HTTP(S). For the REST interface, both ends should be

capable of handling HTTP(S) requests and responses with XML body. For both interfaces, the

messages exchanged are as follows:

CHD2SYS_Hazmat_Updates_Ann


Version: 4.0 15/07/2016

15 of 41

3 HAZMAT EXCHANGE

3.1 Request list of Hazmat items from CHD

3.1.1 Introduction

The SYS2CHD_Hazmat_Req message is sent by an external system, or a system integrated

into SSN, to CHD in order to request a list of Hazmat items, based on specific criteria. The

external system may retrieve all Hazmat items in CHD by providing no criteria in the request.

The CHD sends a CHD_Receipt message to the data requestor and prepares the

SYS2CHD_Hazmat_Res message. Subsequently, the CHD sends the SYS2CHD_Hazmat_Res

message to the data requestor. This message contains the Hazmat items retrieved from CHD,

based on the request criteria.

This section describes the different XML messages provided for this transaction.

3.1.2 Message flow

The following figure outlines the expected asynchronous flow of Hazmat items

request/retrieval by an external system. In case of XML over HTTP messages exchange, the

CHD_Receipt message is sent as a response to SYS2CHD_HAZMAT_Req over a single HTTP

cycle (request-response) with HTTP status code 200. Hence the 202 (Acknowledgement), that

is displayed under the SYS2CHD_HAZMAT_Req is not sent by CHD.

Note:

The CHD Receipt will be removed in the next release of the S2S interface.

3.1.3 SYS2CHD_Hazmat_Req.xml message

3.1.3.1 Message description

The following table provides a summary of the message content.


Version: 4.0 15/07/2016

16 of 41

Element Attribute Occ

Header 1

Version 1

TestId 0-1

From 1

Το 1

SentAt 1

Email 1

TimeoutValue 1

ESRefId 1

Body 1

FilterCriteria 1

HazmatId 0-1

DGClassification 0-1

TextualReference 0-1

ModeOfCarriage 0-1

TypeOfProduct 0-1

TypeOfLiquid 0-1

UNNumber 0-1

3.1.3.2 Business rules

The following table describes the XML message and the applicable business rules. The

detailed definition of the attributes is included in “ANNEX A - Attributes and Elements

Definitions”.

Ref Element Attribute Description

1 SentAt Format “YYYY-MM-

DDThh:mm:ssTZD”

Where TZD = time zone

designator (Z or +hh:mm or -

hh:mm)

2 ESRefId Unique identifier provided by

the external system

3 TimeoutValue Timeout value (in seconds)

indicating when the request

should be considered as

expired and must not be

processed

4 FilterCriteria If FilterCriteria is empty, the

CHD will return all Hazmat

items

5 DGClassification If DGClassification is specified,

then the retrieval of Hazmat

items will be restricted to a


Version: 4.0 15/07/2016

17 of 41


specific IMO Code.

6 TextualReference The textual reference criterion

will corresponds to different

fields based on the IMO Code.

The mapping of “Textual

Reference” to IMO Code specific

fields is the following:

IMDG: “Proper Shipping

Name”

IBC: “Product name”

IMSBC: “Bulk cargo

Shipping Name”

IGC: “Product Name”

Marpol Annex 1: “Name

of Oil”

7 TypeOfLiquid If the value of the

“TypeOfProduct” element is

“Liquid”, then “TypeOfLiquid”

can be specified as well as a

criterion

8 UNNumber When UNNumber is specified in

as a filter criterion, the search

will be performed against the

Hazmat Items that have a

UNNumber value; therefore,

limiting the search to the

elements of a specific IMO code

(i.e. IMDG).

3.1.3.3 Example message(s)

Example of the message:

<?xml version="1.0" encoding="UTF-8"?> <SYS2CHD_Hazmat_Req xmlns="http://messages.ws.external.chd.hazmat.emsa.eu/"> <Header Version="1.0" From="ExternalSystem1" To="CHD" SentAt="2016-02-15T15:37:55+03:00" Email="[email protected]" TimeOutValue="45" ESRefId="12345" /> <Body> <FilterCriteria> <HazmatId>IMDG_0004_20</HazmatId>

<DGClassification>IMDG</DGClassification> <TextualReference>AMMONIUM</TextualReference> <UNNumber>0004</UNNumber> </FilterCriteria> </Body> </SYS2CHD_Hazmat_Req>


Version: 4.0 15/07/2016

18 of 41

3.1.4 CHD_Receipt.xml message



Item Attributes Occ

Header 1

Version 1

TestId 0-1

From 1

Το 1

SentAt 1

ESRefId 1

SSNCHDRefId 1

StatusCode 1

StatusMessage 0-1


The following table describes the XML message used and the applicable business rules. The


Definitions”.


1 ESRefId The ESRefId specified in the

request message by the external

system.

2 SSNCHDRefId Reference number given by the

CHD application.


DDThh:mm:ssTZD”

Where TZD = time zone designator

(Z or +hh:mm or -hh:mm).



<?xml version="1.0" encoding="UTF-8"?> <CHD_Receipt xmlns="http://messages.ws.external.chd.hazmat.emsa.eu/"> <Header Version="1.0" From="CHD" To="ExternalSystem1" SentAt="2016-02-15T15:40:55+03:00" ESRefId="12345" SSNCHDRefId="a50f4fa0-eb60-11e5-985b-0002a5d5c51b" StatusCode="OK" StatusMessage="The original message has been successfully received"/> </CHD_Receipt>


Version: 4.0 15/07/2016

19 of 41

3.1.4.4 Status Code

A status code is defined in every response/receipt message. It is defined as the StatusCode

attribute included in the Header element with the following set of values:

Attribute value Description

InvalidFormat The corresponding XML

request message was not

valid

ServerError The corresponding XML

request message has not

been successfully processed

due to a server problem

(e.g. connection problem,

database problem,

application problem, etc.)

OK The request has been

successfully received and

processed

AccessDenied The user (identified via the

From attribute of the

Header element) has not

the required privileges to

perform the request (see

important notes of section

1.3)

OtherError An error occurred that is

described in the

StatusMessage attribute.

3.1.4.5 Status Message

The optional StatusMessage attribute might be used to pass on more detailed information

about the status code value.

This status message is free text and can be useful for troubleshooting purposes. The message

should be in English.


Version: 4.0 15/07/2016

20 of 41

3.1.5 CHD2SYS_Hazmat_Res.xml message



Item Attributes Occ

Header 1

Version 1

TestId 0-1

From 1

Το 1

SentAt 1

ESRefId 1

SSNCHDRefId 1

StatusCode 1

StatusMessage 0-1

Body 1

Results 1

HazmatItem 0-∞

HazmatId 1

IMOCode 1

TextualReference 1

ModeOfCarriage 1

TypeOfProduct 0-1

TypeOfLiquid 0-1

IMOHazardClass 0-1

UNNumber 0-1

PackingGroup 0-1

SubsidiaryRisks 0-1

SubsidiaryRisk 0-5

FlashPoint 0-1

MarinePollutant 0-1

PollutionCategory 0-1

EmSList 0-1

EmS 0-3

AdditionalInformation 0-1


The following table describes the XML message and the applicable business rules. The


Definitions”.


Version: 4.0 15/07/2016

21 of 41


1 ESRefId The ESRefId specified in the

request message by the

external system.

2 SSNCHDRefId Reference number given by

the CHD application.


DDThh:mm:ssTZD”



hh:mm).

4 TypeOfLiquid Defined only when

“TypeOfProduct” value is

“Liquid”



<?xml version="1.0" encoding="UTF-8"?>

<CHD2SYS_Hazmat_Res xmlns="http://messages.ws.external.chd.hazmat.emsa.eu/"> <Header Version="1.0" From="CHD" To="ExternalSystem1" SentAt="2016-02-15T15:40:55+03:00" ESRefId="12345" SSNCHDRefId="bf1f6fa0-eb60-11e5-985b-d5c51b0002a5" StatusCode=”OK” StatusMessage=”Successfully processed”/> <Body> <Results> <HazmatItem HazmatId="IMDG_0004_23" IMOCode="IMDG">

<TextualReference>AMMONIUM PICRATE dry or wetted with less than 10% water, by mass</TextualReference> <ModeOfCarriage>Packaged</ModeOfCarriage> <IMOHazardClass>1</IMOHazardClass> <UNNumber>0004</UNNumber> <PackingGroup>I</PackingGroup>

<SubsidiaryRisks> <SubsidiaryRisk>6.1/8</SubsidiaryRisk> <SubsidiaryRisk>6.1</SubsidiaryRisk> </SubsidiaryRisks> <FlashPoint>11°C</FlashPoint> <MarinePollutant>P</MarinePollutant> <EmSList>

<EmS>F-B</EmS> <EmS>S-Y</EmS> </EmSList>

<AdditionalInformation>Liquefied, non-flammable gas with a chloroform-like odour. Much heavier than air (5.9)</AdditionalInformation> </HazmatItem> <HazmatItem HazmatId="IBC.0000.56" IMOCode="IBC">

<TextualReference>Acetic acid</TextualReference> <ModeOfCarriage>Bulk</ModeOfCarriage> <TypeOfProduct>Liquid</TypeOfProduct> <TypeOfLiquid>Chemicals or noxious</TypeOfLiquid> <IMOHazardClass>S</IMOHazardClass> <PollutionCategory>X</PollutionCategory>

</HazmatItem> </Results>


Version: 4.0 15/07/2016

22 of 41

</Body>

</CHD2SYS_Hazmat_Res>

3.2 Subscribe to CHD for updates of Hazmat items

3.2.1 Introduction

The SYS2CHD_Hazmat_Updates_Sub message is sent by an external system, or a system

integrated into SSN, to CHD in order to request for a subscription to updates on Hazmat

items in CHD. The SYS2CHD_Hazmat_Updates_Sub may be also sent by an existing

subscriber in order to modify the subscription. The subscriber may generate the appropriate

SYS2CHD_Hazmat_Updates_Sub message and request the cancellation of its subscription. In

response to a subscription request, the CHD sends the CHD_Receipt message to the external

system as a confirmation of the subscription status modification.


3.2.2 Message flow

The following figure outlines the expected synchronous flow of the subscription to Hazmat

items request/receipt cycle. In case of XML over HTTP messages exchange, the CHD_Receipt

message is sent as a response to SYS2CHD_HAZMAT_Upates_Sub over a single HTTP cycle

(request-response) with HTTP status code 200. Hence the 202 (Acknowledgement), that is

displayed under the SYS2CHD_HAZMAT_Req is not send by CHD.


Version: 4.0 15/07/2016

23 of 41

3.2.3 SYS2CHD_Hazmat_Updates_Sub.xml message



Item Attributes Occ

Header 1

Version 1

TestId 0-1

From 1

Το 1

SentAt 1

Email 1

ESRefId 1

Body 1

Subscription 1

RequestType 1

SubscritpionStart 0-1

SubscriptionEnd 0-1


The following table describes the XML message used and the applicable business rules. The


Definitions”.


1 ESRefId Unique identifier supplied by

the external system


DDThh:mm:ssTZD”



hh:mm)

3 RequestType One of the following

enumeration values:

CreateOrUpdate

Cancel

4 SubscriptionStart Must be specified only when

“RequestType” is

“CreateOrUpdate”

5 SubscriptionEnd Must be specified only when


Version: 4.0 15/07/2016

24 of 41


“RequestType” is

“CreateOrUpdate”

Must be a date after the

defined SubscriptionStart

date.



<?xml version="1.0" encoding="UTF-8"?>

<SYS2CHD_Hazmat_Updates_Sub xmlns="urn:eu.emsa.chd">

<Header Version="1.0" From="ExternalSystem1" To="CHD" SentAt="2016-02-15T16:37:55Z" Email=”[email protected]” ESRefId="11-22-33"/> <Body> <Subscription RequestType="CreateOrUpdate" SubscriptionStart="2016-02-15T16:37:55Z " SubscriptionEnd="2017-02-15T16:37:55Z ">

</Body> </SYS2CHD_Hazmat_Updates_Sub>

3.3 Push updates of Hazmat items to subscriber

3.3.1 Introduction

The SYS2CHD_Hazmat_Updates_Ann message is sent by CHD to a system that has previously

subscribed to the CHD Hazmat items updates “push” service, in order to push updates on

Hazmat items stored in CHD. The push of updates is scheduled to follow the updates of the

on-line version of the CHD.


3.3.2 Message flow

The following figure outlines the expected flow of the announcement of Hazmat items

updates.

3.3.3 CHD2SYS_Hazmat_Updates_Ann.xml message



Item Attributes Occ


Version: 4.0 15/07/2016

25 of 41

Item Attributes Occ

Header 1

Version 1

TestId 0-1

From 1

Το 1

SentAt 1

ESRefId 1

SSNCHDRefId 1

DatasetVersionDate 1

StatusCode 1

StatusMessage 0-1

Body 1

HazmatEvents 1

HazmatEvent 0-∞

EventType 1

HazmatItem 1

HazmatID 1

IMOCode 1

TextualReference 1

ModeOfCarriage 1

TypeOfProduct 0-1

TypeOfLiquid 0-1

IMOHazardClass 0-1

UNNumber 0-1

PackingGroup 0-1

SubsidiaryRisks 0-1

SubsidiaryRisk 0-5

FlashPoint 0-1

MarinePollutant 0-1

PollutionCategory 0-1

EmSList 0-1

EmS 0-3

AdditionalInformation 0-1


The following table describes the XML message used for the transaction and the applicable

business rules. The detailed definition of the attributes is included in “ANNEX A - Attributes

and Elements Definitions”.


Version: 4.0 15/07/2016

26 of 41


1 ESRefId The ESRefId supplied by the

external system in the

corresponding subscription request.

2 SSNCHDRefId Reference id supplied by the CHD

application


DDThh:mm:ssTZD”

Where TZD = time zone designator

(Z or +hh:mm or -hh:mm).

4 EventType One of the following enumeration

values:

CreateOrUpdate

Delete

5 IMOCode Optional. One of the following

enumeration values:

IMDG

IBC

IMSBC

IGC

Marpol Annex 1

6 TypeOfLiquid Defined only when “TypeOfProduct”

is “Liquid”


<?xml version="1.0" encoding="UTF-8"?> <CHD2SYS_Hazmat_Updates_Ann xmlns="urn:eu.emsa.chd"> <Header Version="1.0" From="CHD" To="ExternalSystem1" SentAt="2016-02-30T15:40:55+03:00"

ESRefId="11-22-33" SSNCHDRefId="c9c72340-eb6a-11e5-a241-0002a5d5c51b"

DatasetVersionDate="2016-02-20T15:40:55+03:00" StatusCode="OK" StatusMessage="Successfully

processed"/> <Body> <HazmatEvents> <HazmatEvent EventType="CreateOrUpdate">

<HazmatItem HazmatId="IMDG.0004.23" IMOCode="IMDG"> <TextualReference>AMMONIUM PICRATE dry or wetted with less than 10% water, by mass</TextualReference>

<ModeOfCarriage>Packaged</ModeOfCarriage> <IMOHazardClass>1</IMOHazardClass> <UNNumber>0004</UNNumber>

<PackingGroup>I</PackingGroup> <SubsidiaryRisks> <SubsidiaryRisk>6.1/8</SubsidiaryRisk> </SubsidiaryRisks> <FlashPoint>11°C</FlashPoint> <MarinePollutant>P</MarinePollutant> <EmSList>

<EmS>F-B</EmS> <EmS>S-Y</EmS> </EmSList>


Version: 4.0 15/07/2016

27 of 41

<AdditionalInformation>Liquefied, non-flammable gas with a chloroform-like odour. Much

heavier than air (5.9)</AdditionalInformation> </HazmatItem> </HazmatEvent> <HazmatEvent EventType="Delete"> <HazmatItem HazmatId="IBC.0000.3"/> </HazmatEvent> </HazmatEvents>

</Body> </CHD2SYS_Hazmat_Updates_Ann>


Version: 4.0 15/07/2016

28 of 41

ANNEX A - ATTRIBUTES AND ELEMENTS DEFINITIONS

Attribute/Element

name Type Len Description and general rules

Message(s) that the attribute is

included

AdditionalInformation string 0-2048

Any additional information regarding

dangerous and polluting goods on-board

(Properties and Observations in the IMDG list)

CHD2SYS_Hazmat_Res.xml

SYS2CHD_Hazmat_Updates_Ann.xml

Body node

The “Body” element of each message contains

the business data of interest, to be exchanged

during the specific transaction.

SYS2CHD_Hazmat_Req.xml


SYS2CHD_Hazmat_Updates_Sub.xml


DatasetVersionDate date

The date that the submitted dataset version

was created in CHD (i.e. the CHD Online

version creation date).


DGClassification string 0-1024

Attribute contains the information in which

IMO Code(s) DG must be declared.

Possible values are in the following enum:

IMDG

IBC

IMSBC

IGC

MARPOL_ANNEX1

In case the DGClassification criterion is

specified, CHD will return all Hazmat items

that belong to this IMO Code.


Email String 0-1024

Attribute contains the email of the requestor

of the subscriber. A notification message will

be sent to this email in case the CHD cannot

send successfully a response or an

announcement.



EmS string 0-1024 Emergency response procedures for ships CHD2SYS_Hazmat_Res.xml


Version: 4.0 15/07/2016

29 of 41

Attribute/Element



included

carrying dangerous goods. Two values are

possible: Fire (F) and Spillage (S). Possible

values are:

“F-A” to “F-J” “S-A” to “S-Z”9


EmSList node

Grouping node that groups all “EmS” array

elements (“EmS” XML elements) in a

“HazmatItem”.



ESRefId string

Reference number created by the external

system when performing a request for hazmat

items or a subscription request for updates in

CHD. The same id is re-transmitted by CHD in

related following Receipt.xml messages, as

well as in CHD2SYS_Hazmat_Res.xml and

CHD2SYS_Hazmat_Updates_Ann.xml

depending on the request type.

All messages

EventType enum

The type of the “HazmatEvent” request:

“CreateOrUpdate”: The

“HazmatItem” contained in the specific

event should be created in the external

system with the provided “HazmatId”,

or if the specific “HazmatId” already

exists, the Hazmat item with this id

should be replaced by the

corresponding “HazmatItem” included

in the XML.

“Delete”: The Hazmat item with this

id must be deleted from the external

system (if exists).



Version: 4.0 15/07/2016

30 of 41

Attribute/Element



included

FilterCriteria node

Grouping node that groups all filter criteria in

a request for Hazmat items by an external

system. In case this node contains no child

elements, then all Hazmat items are returned

by CHD.


FlashPoint string 0-1024

The temperature in degrees Celsius at which a

liquid will give off enough flammable vapour to

be ignited. (Note: In the IMDG list this is

contained within the Properties and

Observations column). Free text



From string

The UserID of the originator of the message

(as defined in EMSA IdM – see important

notes of section 1.3).

All messages

HazmatEvent node

A modification that must be applied to the

current dataset of the external system. May

contain only one (in case of “CreateOrUpdate”

“EventType”) or zero (in case of “Delete”

“EventType”) “HazmatItem”s


HazmatEvents node

Grouping element that groups all

“HazmatEvents” to be executed during the

specific update. The order that the updates

must be applied is the order of the

“HazmatEvent”s in the “HazmatEvents”

element.


HazmatId (attribute) string 0-30 The id of the hazmat item as maintained in

the CHD.




HazmatItem node A single Hazmat item entry. May contain any

subset of the child fields (maximum one




Version: 4.0 15/07/2016

31 of 41

Attribute/Element



included

occurrence per direct child field), depending

on the corresponding “IMOCode” definition.

Header node

The “Header” element of each message that

contains metadata about the rooting and

handling of the message.

All messages

IMOCode enum

One of the following values is possible:

IMDG

IBC

IMSBC

IGC

Marpol Annex 1



IMOHazardClass enum

In accordance with IMDG, IBC, and IMSBC

codes. Possible values are:

“1” to “9” and relevant sub-classes

“S”, “P”,

“B”, “A and B”.



MarinePollutant string 0-1024

The code value defined in MARPOL Annex III

and IMDG. (Note: In the IMDG list this is

contained within the Subsidiary Risks column).

Possible values are:

“P”, “-“.



ModeOfCarriage string 0-1024

Depending on the relevant IMO code or

convention. Possible values are:

Packaged

Bulk


PackingGroup string 0-1024 Values as appropriate and as defined in IMDG CHD2SYS_Hazmat_Res.xml


Version: 4.0 15/07/2016

32 of 41

Attribute/Element



included


PollutionCategory string 0-1024 The code values defined in MARPOL Annex II

and IBC.



RequestType enum

The type of the subscription request. One of

the values:

CreateOrUpdate: creates a new

subscription for the external system in

CHD. In case a subscription exists it

gets updated

Cancel


Results node Grouping elements that contain CHD2SYS_Hazmat_Res.xml

SubsidiaryRisk string 0-1024

Any risks in addition to the class to which

dangerous goods are assigned; and which is

determined by a requirement to have a

subsidiary risk. A dangerous good may have

up to 5 subsidiary risks. Free text.



SentAt date

Date and time the message was sent. If local

time is used external application has to adjust

the time to UTC.

All messages

SSNCHDRefId

The reference number created by CHD and

included in every message that is sent to an

external system. This id is also included in

CHD_Receipt.xml messages sent by the

external systems to CHD.



CHD_Receipt.xml

StatusCode enum

Global status code. See “Status Code” section

for possible values

CHD_Receipt.xml




Version: 4.0 15/07/2016

33 of 41

Attribute/Element



included

StatusMessage string 0-255 Global status message string

CHD_Receipt.xml



Subscription node Contains subscription request details SYS2CHD_Hazmat_Updates_Sub.xml

SubsidiaryRisks node

Grouping node that groups all Subsidiary Risk

array elements (“SubsidiaryRisk” XML

elements) in a “HazmatItem”



SubscriptionStart dateTime The start date of a subscription to Hazmat

updates. Must be a future date SYS2CHD_Hazmat_Updates_Sub.xml

SubscriptionEnd dateTime

The end date of a subscription to Hazmat

updates. Must be a future date and also after

SubscriptionStart


TestId string Test Case identification. Only useful for

testing. All messages

TextualReference string 0-1024

Its content is derived from the appropriate

IMO Code and Conventions. Possible values

are:

Proper Shipping Name

Product name

Bulk cargo Shipping Name

Product Name

Name of Oil


TimeoutValue

Timeout value (in seconds) indicating when

the request should be considered as expired

and must not be processed.



Version: 4.0 15/07/2016

34 of 41

Attribute/Element



included

To string The UserID of the recipient of the message (as

defined in EMSA IdM). All messages

TypeOfProduct enum


convention. Possible values are:

Liquid

Solid

Gas



SYS2CHD_Hazmat_updates_Ann.xml

TypeOfLiquid enum


convention. Present only when

“TypeOfProduct” is “Liquid”. Possible values

are:

“Chemicals or noxious”

“Oil”




UNNumber string 0-4 UN number of HAZMAT product in accordance

with the IMO Codes.




Version string Current version of the interface utilized (‘x.x’) All messages


Version: 4.0 15/07/2016

35 of 41

ANNEX B - DESCRIPTION OF WEB-SERVICES

Two message exchange systems utilizing web services are implemented for the exchange of

Hazmat items between CHD and external applications. The services in the one set are based

on the XML messages exchange over HTTP while the other utilizes the SOAP protocol. For the

hazmat request mechanism, either both or just one of the architectures may be implemented

by the external system. Regarding the hazmat updates subscription mechanism, only one

subscription is allowed per external system. Consequently, if an external system requests

subscription for both architectures with the same “From” attribute, the second subscription

request will update the first subscription. The structure of the XML messages exchanged in

the body of the REST/SOAP bodies is common for both architectures.

REST ARCHITECTURE

Overview

HTTP(S) protocol is utilized for the transmission of the XML messages. An external system

that submits an HTTP(S) request must receive a CHD_Receipt message synchronously,

included in the body of the HTTP response with HTTP status code 200 (OK). In case of any

other HTTP code, the requestor system must understand that the submitted XML message

was not processed at all. Consequently, the specific service invocation must be considered as

failed.

In addition to the HTTP(S) status codes that are related with the successful delivery of the

XML message, the value of the custom StatusCode element in the header of the XML message

relates to the successful or not processing of the XML message. Any business related error

(including the XML validation errors) must be depicted in this element.

For each service invocation, the external system that submits the HTTP(S) request must

create the request and submit it to the URL of the web service endpoint using the HTTP

method specified in this document for the specific endpoint. In the HTTP header of the

request, the calling system must specify the custom HTTP headers specified in this document

for the specific request type.

In the body of the request, the external system should include the corresponding XML

document. If the HTTP code of the HTTP response is 200“OK” and the StatusCode value in the

included CHD_Receipt message is “OK”, the external system should wait for an XML message

in the HTTP body of a subsequent request. This request will be performed against the URL

specified in the value of the x-callbackurl HTTP header of the initial request.

The following REST services must be implemented for the Hazmat items exchange

mechanisms:

Hazmat items request mechanism

/hazmatitemsrequest

Request

HTTP method: POST

HTTP headers: x-callbackurl

XML Message: SYS2CHD_Hazmat_Req.xml

XSD for XML message expected in body: SYS2CHD_Hazmat_Req.xsd

Example message: See paragraph 3.1.3.3

Response

HTTP headers: N/A

XML Message: CHD_Receipt.xml


Version: 4.0 15/07/2016

36 of 41

XSD for XML message expected in body: CHD_Receipt.xsd


/hazmatitemsresponse

Request

HTTP method: POST

HTTP headers: N/A

XML Message: CHD2SYS_Hazmat_Res.xml

XSD for XML message expected in body: CHD2SYS_Hazmat_Res.xsd


Response

202 “Accepted”

Hazmat items updates subscription mechanism

/hazmatupdatessub

Request

HTTP method: POST

HTTP headers: x-callbackurl

XML Message: SYS2CHD_Hazmat_Updates_Sub.xml

XSD for XML message expected in body: SYS2CHD_Hazmat_Updates_Sub.xsd


Response

HTTP headers: N/A

XML Message: CHD_Receipt.xml

XSD for XML message expected in body: CHD_Receipt.xsd


Hazmat updates push mechanism

/hazmatupdatesann

Request

HTTP method: POST

HTTP headers: N/A

XML Message: CHD2SYS_Hazmat_Updates_Ann.xml

XSD for XML message expected in body: CHD2SYS_Hazmat_Updates_Ann.xsd


Response

202 “Accepted”

SOAP ARCHITECTURE For the SOAP based architecture, the WS-Addressing specification is utilized. The external

system notifies the CHD about its callback endpoint URL (both for the request/response and

the subscription/announcement cycles) using the ReplyTo header element of the SOAP

envelope. On the other hand, the CHD must use the RelatesTo SOAP envelope header

element in the responses, receipts and announcements sent to the external systems, in order


Version: 4.0 15/07/2016

37 of 41

to correlate the specific message to the corresponding request or subscription respectively.

For any conflict between the SOAP envelope header elements and the respective CHD XML

message, the SOAP envelope headers always prevail.

The SOAP body of both the request and the response must include the XML messages

specified in the following services descriptions respectively.

The following operations must be implemented for the Hazmat items exchange mechanisms:

Hazmat items request mechanism

HazmatItemsPortType/hazmatRequest

Sample SOAP request message:

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:mes="http://messages.ws.external.chd.hazmat.emsa.eu/">

<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">

<wsa:Action soap:mustUnderstand="1">http://ws.external.chd.hazmat.emsa.eu/HazmatItemsPortType/hazmatRequ

est</wsa:Action>

<wsa:ReplyTo soap:mustUnderstand="1">

<wsa:Address>http://hazmatRequestor/hazmat</wsa:Address>

</wsa:ReplyTo>

<wsa:MessageID soap:mustUnderstand="1">uuid:3d61fe26-683f-497d-9af0-7edf2379aaeb</wsa:MessageID>

</soap:Header>

<soap:Body>

<mes:SYS2CHD_Hazmat_Req>

<Header Version="1.0" From="ES1" To="CHD" SentAt="2016-07-12T12:57:25.514+03:00" Email="[email protected]" TimeoutValue="45" ESRefId="123456"/>

<Body>

<FIlterCriteria>

<HazmatID>IMDG_0186_99</HazmatID>

</FIlterCriteria>

</Body>

</mes:SYS2CHD_Hazmat_Req>

</soap:Body>

</soap:Envelope>

HazmatItemsPortType/hazmatRequestResponse


<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">

<S:Header>

<Action xmlns="http://www.w3.org/2005/08/addressing" xmlns:S="http://www.w3.org/2003/05/soap-envelope" S:mustUnderstand="true">http://ws.external.chd.hazmat.emsa.eu/HazmatItemsPortType/hazmatRequestResponse</Action>

<MessageID xmlns="http://www.w3.org/2005/08/addressing">uuid:3c0852ff-0398-4ff3-aee7-64a809fa010b</MessageID>


Version: 4.0 15/07/2016

38 of 41

<RelatesTo xmlns="http://www.w3.org/2005/08/addressing">uuid:3d61fe26-683f-497d-9af0-

7edf2379aaeb</RelatesTo>

<To xmlns="http://www.w3.org/2005/08/addressing">http://hazmatRequestor/hazmat</To>

</S:Header>

<S:Body>

<ns2:CHD_Receipt xmlns:ns2="http://messages.ws.external.chd.hazmat.emsa.eu/">

<Header Version="1" From="CHD" To="ES1" SentAt="2016-07-12T18:03:47.114+03:00" ESRefId="123456" SSNCHDRefId="b6dba50f-abc2-4bd1-9e5c-b9370e11de38" StatusCode="OK"

StatusMessage="The original message has been successfully received"/>

</ns2:CHD_Receipt>

</S:Body>

</S:Envelope>

HazmatRequestorPortType/hazmatResponse



<S:Header>

<RelatesTo xmlns="http://www.w3.org/2005/08/addressing">uuid:3d61fe26-683f-497d-9af0-

7edf2379aaeb</RelatesTo>

<To xmlns="http://www.w3.org/2005/08/addressing">http://hazmatRequestor/hazmat</To>

<Action xmlns="http://www.w3.org/2005/08/addressing">http://ws.external.chd.hazmat.emsa.eu/HazmatRequestorPortType/hazmatResponse</Action>

</S:Header>

<S:Body>

<ns2:CHD2SYS_Hazmat_Res xmlns:ns2="http://messages.ws.external.chd.hazmat.emsa.eu/">

<Header Version="1" From="CHD" To="http://10.100.1.30:8088/mock/hazmat" SentAt="2016-07-12T18:03:47.261+03:00" ESRefId="123456" SSNCHDRefId="81a2c82e-3425-429b-8918-c09b9d457737" StatusCode="ΟΚ" StatusMessage="Successfully processed"/>

<Body>

<Results>

<HazmatItem HazmatId="IMDG_0186_99" IMOCode="IMDG">

<TextualReference>ROCKET MOTORS</TextualReference>

<ModeOfCarriage>Packaged</ModeOfCarriage>

<IMOHazardClass>1.3 C</IMOHazardClass>

<UNNumber>0186</UNNumber>

<SubsidiaryRisks/>

<EmSList>

<EmS>F - B</EmS>

<EmS>S - X</EmS>

</EmSList>

<AdditionalInformation>See glossary of terms in appendix B.</AdditionalInformation>


Version: 4.0 15/07/2016

39 of 41

</HazmatItem>

</Results>

</Body>

</ns2:CHD2SYS_Hazmat_Res>

</S:Body>

</S:Envelope>

Hazmat items updates subscription mechanism

HazmatItemsPortType/hazmatSubscription


<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:mes="http://messages.ws.external.chd.hazmat.emsa.eu/">[\n]"

<soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing">

<wsa:Action soap:mustUnderstand="1">http://ws.external.chd.hazmat.emsa.eu/HazmatItemsPortType/hazmatSubscription</wsa:Action>

<wsa:ReplyTo soap:mustUnderstand="1">

<wsa:Address>http://externalsystem/updates</wsa:Address>

</wsa:ReplyTo>

<wsa:MessageID soap:mustUnderstand="1">uuid:d110d99b-8ccd-47e6-9368-1cf7534fd98e</wsa:MessageID>

</soap:Header>[\n]"

<soap:Body>

<mes:SYS2CHD_Hazmat_Updates_Sub>

<Header Version="1.0" From="ES1" To="CHD" SentAt="2016-07-13T13:49:12.099+03:00" Email="[email protected]" ESRefId="123456"/>

<Body>

<Subscription RequestType="CreateOrUpdate" SubscriptionStart="2016-07-13T13:49:12.100+03:00" SubscriptionEnd="2016-07-13T13:49:12.100+03:00"/>

</Body>

</mes:SYS2CHD_Hazmat_Updates_Sub>

</soap:Body>

</soap:Envelope>"

HazmatItemsPortType/hazmatSubscriptionResponse



<S:Header>

<Action xmlns="http://www.w3.org/2005/08/addressing" xmlns:S="http://www.w3.org/2003/05/soap-envelope" S:mustUnderstand="true">http://ws.external.chd.hazmat.emsa.eu/HazmatItemsPortType/hazmatSubs

criptionResponse</Action>

<MessageID xmlns="http://www.w3.org/2005/08/addressing">uuid:WLS2:server:ext_cluster_1:c1a85b984bd5fecd:3a4d6080:155e3d10b71:-7fec</MessageID>

<RelatesTo xmlns="http://www.w3.org/2005/08/addressing">uuid:38cc7edf-1ed6-4a8d-be11-b0442aabb2fb</RelatesTo>

<To xmlns="http://www.w3.org/2005/08/addressing">http://externalsystem/updates</To>


Version: 4.0 15/07/2016

40 of 41

</S:Header>

<S:Body>

<ns2:CHD_Receipt xmlns:ns2="http://messages.ws.external.chd.hazmat.emsa.eu/">

<Header Version="1" From="CHD" To="ES1" SentAt="2016-07-13T11:02:06.816Z" ESRefId="123456" SSNCHDRefId="a7dabcf3-8b71-448d-8248-aac27df971c3" StatusCode="OK" StatusMessage="The original message has been successfully received"/>

</ns2:CHD_Receipt>

</S:Body>

</S:Envelope>

Hazmat updates push mechanism

HazmatRequestorPortType/hazmatAnnouncement



<S:Header>

<Action xmlns="http://www.w3.org/2005/08/addressing" xmlns:S="http://www.w3.org/2003/05/soap-envelope" S:mustUnderstand="true">http://ws.external.chd.hazmat.emsa.eu/HazmatUpdatesPortType/hazmatAnnouncement</Action>

<MessageID xmlns="http://www.w3.org/2005/08/addressing">uuid:WLS2:server:ext_cluster_1:c1a85b984bd5fecd:3a4d6080:155e3d10b71:-7fec</MessageID>

<RelatesTo xmlns="http://www.w3.org/2005/08/addressing">uuid:38cc7edf-1ed6-4a8d-be11-b0442aabb2fb</RelatesTo>

<To xmlns="http://www.w3.org/2005/08/addressing">http://externalsystem/updates</To>

</S:Header>

<S:Body> <CHD2SYS_Hazmat_Updates_Ann xmlns="urn:eu.emsa.chd"> <Header Version="1.0" From="CHD" To="ExternalSystem1" SentAt="2016-02-30T15:40:55+03:00" ESRefId="11-22-33" SSNCHDRefId="c9c72340-eb6a-11e5-a241-0002a5d5c51b" DatasetVersionDate="2016-02-30T11:20:00+03:00"/>

<Body> <HazmatEvents> <HazmatEvent EventType="CreateOrUpdate"> <HazmatItem HazmatId="IMDG_0004._23" IMOCode="IMDG"> <TextualReference>AMMONIUM PICRATE dry or wetted with less than 10% water, by mass</TextualReference> <ModeOfCarriage>Packaged</ModeOfCarriage>

<IMOHazardClass>1</IMOHazardClass> <UNNumber>0004</UNNumber> <PackingGroup>I</PackingGroup> <SubsidiaryRisks>

<SubsidiaryRisk>6.1/8</SubsidiaryRisk> </SubsidiaryRisks> <FlashPoint>11°C</FlashPoint>

<MarinePollutant>P</MarinePollutant> <EmSList> <EmS>F-B</EmS> <EmS>S-Y</EmS> </EmSList> <AdditionalInformation>Liquefied, non-flammable gas with a chloroform-like odour.

Much heavier than air (5.9)</AdditionalInformation> </HazmatItem> </HazmatEvent> <HazmatEvent EventType="Delete">


Version: 4.0 15/07/2016

41 of 41

<HazmatItem HazmatId="IBC_0000_3"/>

</HazmatEvent> </HazmatEvents> </Body> </CHD2SYS_Hazmat_Updates_Ann> </S:Body> </S:Envelope>

END OF DOCUMENT

System Interface Guide - emsa.europa.eu€¦ · System Interface Guide Version: 4.0 15/07/2016 2 of...

Documents

Transcript of System Interface Guide - emsa.europa.eu€¦ · System Interface Guide Version: 4.0 15/07/2016 2 of...