OpenLegislation

Division 1 Header

United Kingdom

Original text. Later amendments are not shown.

All the XML messages exchanged with the system shall have the same header to identify the sender, the recipient, the date and time sent, and some technical information.

Common HeaderMandatory
VersionThe official version of the XML specifications shall be specified through the namespace defined in the message XML Schema Definition file (XSD) and in the version attribute of the header element of any XML message. The version number (‘n.m’) shall be defined as fixed value in every release of the XSD.Yes
Test IdentifierOptional id for testing. The originator of the test shall populate the id and all participants in the workflow shall forward/return the same id. In production it shall be ignored and shall not be used if it is supplied.No
Technical IdentifierA UUID uniquely identifying each individual message. The sender generates a UUID and populates this attribute. This data is not used in any business capacity.Yes
Workflow IdentifierThe workflow Id is a UUID and shall be generated by the requesting Member State. This id is then used in all messages to correlate the workflow.Yes
Sent AtThe date and time in Coordinated Universal Time (UTC) format when the message was sent.Yes
Timeout

This is an optional date and time (in UTC format) attribute. This value shall be set only by the Hub for forwarded requests. This shall inform the responding Member State of the time when the request will be timed out. It is optional so that the same header definition may be used for all message types regardless of whether or not the Timeout attribute is required.

NOT USED, as we send only notifications, no response is expected.

No
FromThe ISO 3166-1 Alpha 2 code of the Member State sending the message or ‘EU’ (‘EU’ used when sending error messages from the Hub).Yes
ToThe ISO 3166-1 Alpha 2 code of the Member State to which the message is being sent or ‘EU’ (‘EU’ used when sending error messages to the Hub).Yes