Editing My ETSI TS 103 120 Notes (section)

== 6. Message Structure ==

See 6.1 overview for details.

Each message consists of two parts:
* Message Header
* Message Payload (Request | Response)

Request format:

Message > Header > Request Payload > Action Request (one to many) > (GET | CREATE | UPDATE | LIST) > (Object Identifier, Object)

Response format:

Message > Header > Response Payload > Action Response (one to many) > (GET | CREATE | UPDATE | LIST) Response > (Object Identifier, Object)

Top level container for all HI-1 message

Header contains routing and timestamp information - see clause6.2

Payloads contain multiple Actions (either Requests or Responses) - see clause 6.3

Each Action has a Verb such as GET or CREATE – either a request or a response, depending on the message. See clauses 6.4.5 through 6.4.8.

This generally contains an Object Identifier, which identifies the Object being acted on (see clause 7 and clause 8). Depending on the verb. It may also contain an Object.

There may be many Action Requests in a Request message. Each will generally act on a separate message.

In the response, there should be an Action Response for each Action Request (in the absence of errors)

=== 6.2.2. Structure ===

Table 6.1 shows the structure of every valid MessageHeader within an HI-1 message.

{| class="wikitable"
|+ MessageHeader
|-
! Field !! Format !! Description
|-
| SenderIdentifier || EndpointID (see clause 6.2.4 for details) || Nationally unique identifier and country code, sufficient to uniquely identify the Sender node in the message exchange. See clause 6.2.4 for details.
|-
| ReceiverIdentifier || EndpointID (see clause 6.2.4 for details) || Nationally unique identifier and country code, sufficient to uniquely identify the intended Receiver in the message exchange. See clause 6.2.4 for details.
|-
| TransactionIdentifier || UUID (see ETSI TS 103 280 [7]) in IETF RFC 4122 [3] canonical form || Identifier that uniquely identifies the message exchange between a given Sender and Receiver. See clause 6.2.5 for details.
|-
| Timestamp || QualifiedMicrosecondDateTime (see ETSI TS 103 280) || Timestamp indicating the time the message was sent.
|-
| Version || Version (see clause 6.2.3 for details) || Version of the present document and relevant national profile used for interpreting the message.
|}

=== 6.4.1 Overview ===
Clause 6.4 defines a set of verbs to aid the two parties in creating, updating, exchanging and reporting on the HI-1 Objects. It does not dictate business processes that vary nationally.

=== 6.4.2 Action Requests ===
Each Action Request in the Request Payload shall be assigned an Action Identifier (see clause 6.4.4). Each Action Request appears in ascending order of the Action Identifier.

An Action Request shall be one of the following "verbs".

{| class="wikitable sortable"
|+ Action Request types
|-
! Verb !! Description !! Definition
|-
| GET || Retrieve HI-1 Object ||See clause 6.4.5
|-
| CREATE || Create new HI-1 Object || See clause 6.4.6
|-
| UPDATE || Update existing HI-1 Object || See clause 6.4.7
|-
| LIST || List identifiers of HI-1 Objects || See clause 6.4.8
|-
| DELIVER || Deliver an HI-1 Object || See clause 6.4.10
|}
 
The list of verbs is deliberately limited, as they are not intended to describe the business processes. Such higher level
processes should instead be represented by the state of the relevant HI-1 Object. The present document simply provides
a mechanism for transferring objects between participants in the process.

=== 6.4.3 Action Responses ===
A response message sent from a Receiver to a Sender describes the legibility of the Request message received. An Action Response is generated for each Action Request provided in a Request, providing the Request Message as a whole could be understood. Each Action Response contains an Action Identifier that correlates with the Action Identifier provided in the Request. For the avoidance of doubt, in the case of a DELIVER Response, the Action Identifier shall match the one given in the DELIVER Request, and not any associated with the creation of related objects.

An Action Response shall be one of the following "verbs".

{| class="wikitable sortable"
|+ Action Response types
|-
! Verb !! Description !! Definition
|-
| GET RESPONSE || Successful retrieval of HI-1 Object of given identifier in Action Request. || See clause 6.4.5
|-
| CREATE RESPONSE || Receipt of legible Create Request of given identifier in Action Request. || See clause 6.4.6
|-
| UPDATE RESPONSE || Receipt of legible Update Request of given identifier in Action Request. || See clause 6.4.7
|-
| LIST RESPONSE || Successful retrieval of identifiers of given type from Action Request. || See clause 6.4.8
|-
| ERROR INFORMATION || Action Request could not be successfully processed. On receipt of this, the Sender shall regard the Action Request as not having been processed. || See clause 6.4.9
|-
| DELIVER RESPONSE || Successful receipt of an HI-1 Object. || See clause 6.4.10
|}

=== 6.4.5 GET ===

See spec.

=== 6.4.6 CREATE ===

A CREATE Request represents a request for the Receiver to create a new HI-1 Object.

A CREATE Request shall have the following parameters.

{| class="wikitable"
|+ CREATE Request fields
|-
! Field !! Format !! Description !! Mandatory?
|-
| HI1Object || HI-1 Object || epresentation of the HI-1 Object to be created by the Receiver. || Yes
|}

The Receiver shall respond to a successful CREATE Request with a CREATE Response with the following parameters.
{| class="wikitable"
|+ CREATE Response fields
|-
! Field !! Format !! Description !! Mandatory?
|-
| Identifier || Object Identifier (see clause 7.1.2) || Value provided in the CREATE Request. || Yes
|-
| HI1Object || HI-1 Object || HI-1 Object that is identified by the identifier. || No
|}
  
If the Receiver is unable to create an HI-1 Object with the defined identifier, then an Action Error response with an appropriate error code is returned. Unsuccessful creations could be as a result of an already used identifier.

The Receiver may, optionally, return an updated version of the Object as part of the CREATE Response (see table 6.9). This may be useful in situations where the Receiver populates or updates additional fields as part of processing the
CREATE request.

The Receiver shall set the Generation of a created Object to 1 (see clause 7.1.3).