Skip to Content

Wiki source code of Part I. Message

Version 4.2 by Helena on 2025/06/24 10:20
Hide last authors
Helena 2.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 **Corrigendum**
6
7 The following problems with the specification dated April 2011 have been rectified as described below.
8
Helena 2.3 9 **~1. Problem**
Helena 2.2 10
11 Various parts of the the documentation refer to stand-alone concepts, which were part of earlier draft releases but ultimately excluded from the final release of the standard.
12
13 **Rectification**
14
15 The documentation of the Structure element (line 40) has been updated to remove this reference.
16
Helena 2.3 17 = 1. Introduction =
Helena 2.2 18
19 At the core of the SDMX XML messages are the message namespaces. These namespaces define the general structure of all messages and define the specific messages that are available for exchange in SDMX.
20
21 There are two namespaces associated with the messages. The main namespace schema which defines every message in SDMX is http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message. Associated with this is another sub-namespace, http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message/footer. This namespace defines footer level information that is available in messages which might require non-standard payload information to be transmitted.
22
23 In general, every message in SDMX follows common format of:
24
25 * Header
26 * Payload (0..n)
27 * Footer (0..1)
28
29 The header and payload elements exist in the message namespace, but the content of the payload is defined in the namespaces that are specific the functionality of the messages. Note that the header follows a common construct, which is then restricted according to the requirements of the message which is using it.
30
Helena 2.3 31 = 2. Schema Documentation =
Helena 2.2 32
Helena 2.3 33 == 2.1 Message Namespace ==
34
Helena 2.2 35 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message**
36
Helena 2.3 37 === 2.1.1 Summary ===
Helena 2.2 38
39 Referenced Namespaces:
40
Helena 3.1 41 (% style="width:788.294px" %)
42 |(% style="width:612px" %)**Namespace**|(% style="width:173px" %)**Prefix**
43 |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:173px" %)com
44 |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/generic|(% style="width:173px" %)dat
45 |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific|(% style="width:173px" %)dsd
46 |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message/footer|(% style="width:173px" %)ftr
47 |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic|(% style="width:173px" %)rep
48 |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific|(% style="width:173px" %)msd
49 |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/query|(% style="width:173px" %)qry
50 |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/registry|(% style="width:173px" %)ref
51 |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure|(% style="width:173px" %)str
52 |(% style="width:612px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:173px" %)xs
Helena 2.2 53
54 Contents:
55
56 50 Global Elements
57 62 Complex Types
58 1 Simple Type
59
Helena 3.1 60 === 2.1.2 Global Elements ===
Helena 2.2 61
62 **Structure (StructureType): **Structure is a message that contains structural metadata. It may contain any of the following; categorisations, category schemes, code lists, concepts (concept schemes), constraints (attachment and content) data flows, hierarchical code lists, metadata flows, metadata structure definitions, organisation schemes, processes, reporting taxonomies, and structure sets.
63
64 **GenericData (GenericDataType): **GenericData is used to convey data in a non data structure specific form. Data sets in this message will be each have a related structure specification in the header, which states the data structure the data conforms to and how the data is organised (i.e. the observation dimension).
65
66 **GenericTimeSeriesData (GenericTimeSeriesDataType): **GenericTimeSeriesData is a special derivation of the generic data message which only allows for time series oriented date (i.e. the observation dimension must be time). Although this is a different message, the content of this message will be exactly the same as a generic data message that specifies time as the observation dimension; therefore no additional processing requirements are necessary. This message is intended to only be used when it is necessary to restrict an exchange to being only time series based data.
67
68 **StructureSpecificData (StructureSpecificDataType): **StructureSpecificData is used to convey data structure specific according to data structure definition. The payload of this message (i.e. the data sets) will be based on XML schemas which are specific to the data structure definition and the orientation (i.e. the observation dimension) of the data.
69
70 **StructureSpecificTimeSeriesData (StructureSpecificTimeSeriesDataType): **StructureSpecificTimeSeriesData is a special derivation of the structure specific data message which only allows for time series oriented date (i.e. the observation dimension must be time). Although this is a different message, the content of this message will be exactly the same as a structure specific data message that specifies time as the observation dimension; therefore no additional processing requirements are necessary. This message is intended to only be used when it is necessary to restrict an exchange to being only time series based data.
71
72 **GenericMetadata (GenericMetadataType): **GenericMetadata contains reported metadata in a format which supports any metadata structure definition.
73
74 **StructureSpecificMetadata (StructureSpecificMetadataType): **StructureSpecificMetadata contains reported metadata in a format which is specific to the metadata structure definitions which define the structure of the metadata being reported. This format allows for validation of the metadata against the intended structure. Note that the each metadata set provided will be based on a metadata structure specific schema.
75
76 **RegistryInterface (RegistryInterfaceType): **RegistryInterface is used to conduct all interactions with the SDMX Registry Services.
77
78 **SubmitRegistrationsRequest (SubmitRegistrationsRequestType): **SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request on or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
79
80 **SubmitRegistrationsResponse (SubmitRegistrationsResponseType): **SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a registration requests. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.
81
82 **QueryRegistrationRequest (QueryRegistrationRequestType): **QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.
83
84 **QueryRegistrationResponse (QueryRegistrationResponseType): **QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.
85
86 **SubmitStructureRequest (SubmitStructureRequestType): **SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.
87
88 **SubmitStructureResponse (SubmitStructureResponseType): **SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.
89
90 **SubmitSubscriptionsRequest (SubmitSubscriptionsRequestType): **SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
91
92 **SubmitSubscriptionsResponse (SubmitSubscriptionsResponseType): **SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.
93
94 **QuerySubscriptionRequest (QuerySubscriptionRequestType): **QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
95
96 **QuerySubscriptionResponse (QuerySubscriptionResponseType): **QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.
97
98 **NotifyRegistryEvent (NotifyRegistryEventType): **NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.
99
100 **StructureSpecificDataQuery (DataQueryType): **StructureSpecificDataQuery is used to query SDMX compliant databases or web services for structure specific data.
101
102 **GenericDataQuery (GenericDataQueryType): **GenericDataQuery is used to query SDMX compliant databases or web services for generic data. This is actually a specialization of the structured data query, and therefore can be processed in the same manner.
103
104 **GenericTimeSeriesDataQuery (GenericTimeSeriesDataQueryType): **GenericTimeSeriesDataQuery is used to query SDMX compliant databases or web services for time series only generic data. This is actually a specialization of the generic data query, and therefore can be processed in the same manner. This message is intended to only be used when it is necessary to restrict an exchange to being only time series based data.
105
106 **StructureSpecificTimeSeriesDataQuery (StructureSpecificTimeSeriesDataQueryType): **StructureSpecificTimeSeriesDataQuery is used to query SDMX compliant databases or web services for time series only structure specific data. This is actually a specialization of the structure specific data query, and therefore can be processed in the same manner. This message is intended to only be used when it is necessary to restrict an exchange to being only time series based data.
107
108 **GenericMetadataQuery (MetadataQueryType): **GenericMetadataQuery is used to query SDMX compliant databases or web services for generic format reference metadata.
109
110 **StructureSpecificMetadataQuery (MetadataQueryType): **StructureSpecificMetadataQuery is used to query SDMX compliant databases or web services for metadata structure specific reference metadata.
111
112 **DataSchemaQuery (DataSchemaQueryType): **DataSchemaQuery is used to query SDMX compliant databases or web services for data structure specific schemas for the purpose of validating structured data.
113
114 **MetadataSchemaQuery (MetadataSchemaQueryType): **MetadataSchemaQuery is used to query SDMX compliant databases or web services for metadata structure specific schemas for the purpose of validating structured metadata.
115
116 **StructuresQuery (StructuresQueryType): **StructuresQuery is used to query SDMX compliant databases or web services for any structures based on simple maintainable object properties (e.g. all objects maintained by a maintenance agency).
117
118 **DataflowQuery (DataflowQueryType): **DataflowQuery is used to query SDMX compliant databases or web services for dataflows.
119
120 **MetadataflowQuery (MetadataflowQueryType): **MetadataflowQuery is used to query SDMX compliant databases or web services for metadata flows.
121
122 **DataStructureQuery (DataStructureQueryType): **DataStructureQuery is used to query SDMX compliant databases or web services for data structures definitions.
123
124 **MetadataStructureQuery (MetadataStructureQueryType): **MetadataStructureQuery is used to query SDMX compliant databases or web services for metadata structure definitions.
125
126 **CategorySchemeQuery (CategorySchemeQueryType): **CategorySchemeQuery is used to query SDMX compliant databases or web services for category schemes.
127
128 **ConceptSchemeQuery (ConceptSchemeQueryType): **ConceptSchemeQuery is used to query SDMX compliant databases or web services for concept schemes.
129
130 **CodelistQuery (CodelistQueryType): **CodelistQuery is used to query SDMX compliant databases or web services for codelists.
131
132 **HierarchicalCodelistQuery (HierarchicalCodelistQueryType): **HierarchicalCodelistQuery is used to query SDMX compliant databases or web services for hierarchical codelists.
133
134 **OrganisationSchemeQuery (OrganisationSchemeQueryType): **OrganisationSchemeQuery is used to query SDMX compliant databases or web services for organisation schemes.
135
136 **ReportingTaxonomyQuery (ReportingTaxonomyQueryType): **ReportingTaxonomyQuery is used to query SDMX compliant databases or web services for reporting taxonomies.
137
138 **StructureSetQuery (StructureSetQueryType): **StructureSetQuery is used to query SDMX compliant databases or web services for structure sets.
139
140 **ProcessQuery (ProcessQueryType): **ProcessQuery is used to query SDMX compliant databases or web services for processes.
141
142 **CategorisationQuery (CategorisationQueryType): **CategorisationQuery is used to query SDMX compliant databases or web services for categorisations.
143
144 **ProvisionAgreementQuery (ProvisionAgreementQueryType): **ProvisionAgreementQuery is used to query SDMX compliant databases or web services for provision agreements.
145
146 **ConstraintQuery (ConstraintQueryType): **ConstraintQuery is used to query SDMX compliant databases or web services for constraints.
147
148 **TransformationSchemeQuery (TransformationSchemeQueryType): **TransformationSchemeQuery is used to query SDMX compliant databases or web services for transformation schemes.
149
150 **VtlMappingSchemeQuery (VtlMappingSchemeQueryType): **VtlMappingSchemeQuery is used to query SDMX compliant databases or web services for VTL mapping schemes.
151
152 **NamePersonalisationSchemeQuery (NamePersonalisationSchemeQueryType): **NamePersonalisationSchemeQuery is used to query SDMX compliant databases or web services for name personalisation schemes.
153
154 **RulesetSchemeQuery (RulesetSchemeQueryType): **RulesetSchemeQuery is used to query SDMX compliant databases or web services for ruleset schemes.
155
156 **UserDefinedOperatorSchemeQuery (UserDefinedOperatorSchemeQueryType): **UserDefinedOperatorSchemeQuery is used to query SDMX compliant databases or web services for user defined schemes.
157
158 **CustomTypeSchemeQuery (CustomTypeSchemeQueryType): **CustomTypeSchemeQuery is used to query SDMX compliant databases or web services for custom type schemes.
159
160 **Error (ErrorType): **Error is used to communicate that an error has occurred when responding to a request in an non-registry environment. The content will be a collection of error messages.
161
Helena 3.2 162 === 2.1.3 Complex Types ===
Helena 2.2 163
164 **//MessageType//: **MessageType is an abstract type which is used by all of the messages, to allow inheritance of common features. Every message consists of a mandatory header, followed by optional payload (which may occur multiple times), and finally an optional footer section for conveying error, warning, and informational messages.
165
166 Content:
167
168 Header, {any element with namespace of http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message}*, ftr:Footer?
169
170 Element Documentation:
171
172 |**Name**|**Type**|**Documentation**
173 |Header|//BaseHeaderType//|
174 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
175
176 **StructureType: **StructureType defines the contents of a structure message. The payload is optional since this message may be returned from a web service with only information in the footer.
177
178 Derivation:
179
Helena 4.2 180 * //MessageType// (restriction)
181 ** StructureType
Helena 2.2 182
183 Content:
184
185 Header, Structures?, ftr:Footer?
186
187 Element Documentation:
188
Helena 3.3 189 (% style="width:856.294px" %)
190 |**Name**|(% style="width:210px" %)**Type**|(% style="width:455px" %)**Documentation**
191 |Header|(% style="width:210px" %)StructureHeaderType|(% style="width:455px" %)
192 |Structures|(% style="width:210px" %)str:StructuresType|(% style="width:455px" %)
193 |ftr:Footer|(% style="width:210px" %)ftr:FooterType|(% style="width:455px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 194
195 **GenericDataType: **GenericDataType defines the contents of a generic data message.
196
197 Derivation:
198
Helena 4.2 199 * //MessageType// (restriction)
200 ** GenericDataType
Helena 2.2 201
202 Content:
203
204 Header, DataSet*, ftr:Footer?
205
206 Element Documentation:
207
Helena 3.3 208 (% style="width:847.294px" %)
209 |**Name**|(% style="width:227px" %)**Type**|(% style="width:450px" %)**Documentation**
210 |Header|(% style="width:227px" %)GenericDataHeaderTyp e|(% style="width:450px" %)
211 |DataSet|(% style="width:227px" %)dat:DataSetType|(% style="width:450px" %)
212 |ftr:Footer|(% style="width:227px" %)ftr:FooterType|(% style="width:450px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 213
214 **GenericTimeSeriesDataType: **GenericTimeSeriesDataType defines the structure of the generic time series data message.
215
216 Derivation:
217
Helena 3.3 218 * //MessageType// (restriction)
219 ** GenericDataType (restriction)
220 *** GenericTimeSeriesDataType
Helena 2.2 221
222 Content:
223
224 Header, DataSet*, ftr:Footer?
225
226 Element Documentation:
227
Helena 3.4 228 (% style="width:856.294px" %)
229 |**Name**|(% style="width:239px" %)**Type**|(% style="width:458px" %)**Documentation**
230 |Header|(% style="width:239px" %)GenericTimeSeriesDat aHeaderType|(% style="width:458px" %)
231 |DataSet|(% style="width:239px" %)dat: TimeSeriesDataSetTyp e|(% style="width:458px" %)
232 |ftr:Footer|(% style="width:239px" %)ftr:FooterType|(% style="width:458px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 233
234 **StructureSpecificDataType: **StructureSpecificDataType defines the structure of the structure specific data message. Note that the data set payload type is abstract, and therefore it will have to be assigned a type in an instance. This type must be derived from the base type referenced. This base type defines a general structure which can be followed to allow for generic processing of the data even if the exact details of the data structure specific format are not known.
235
236 Derivation:
237
Helena 3.4 238 * //MessageType// (restriction)
239 ** StructureSpecificDataType
Helena 2.2 240
241 Content:
242
243 Header, DataSet*, ftr:Footer?
244
245 Element Documentation:
246
Helena 3.4 247 (% style="width:828.294px" %)
248 |**Name**|(% style="width:247px" %)**Type**|(% style="width:420px" %)**Documentation**
249 |Header|(% style="width:247px" %)StructureSpecificDat aHeaderType|(% style="width:420px" %)
250 |DataSet|(% style="width:247px" %)//dsd:DataSetType//|(% style="width:420px" %)
251 |ftr:Footer|(% style="width:247px" %)ftr:FooterType|(% style="width:420px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 252
253 **StructureSpecificTimeSeriesDataType: **StructureSpecificTimeSeriesDataType defines the structure of the structure specific time series data message.
254
255 Derivation:
256
Helena 3.4 257 * //MessageType// (restriction)
258 ** StructureSpecificDataType (restriction)
259 *** StructureSpecificTimeSeriesDataType
Helena 2.2 260
261 Content:
262
263 Header, DataSet*, ftr:Footer?
264
265 Element Documentation:
266
Helena 3.5 267 (% style="width:839.294px" %)
268 |**Name**|(% style="width:256px" %)**Type**|(% style="width:434px" %)**Documentation**
269 |Header|(% style="width:256px" %)StructureSpecificTim eSeriesDataHeaderTyp e|(% style="width:434px" %)
270 |DataSet|(% style="width:256px" %)//dsd: TimeSeriesDataSetTyp e//|(% style="width:434px" %)
271 |ftr:Footer|(% style="width:256px" %)ftr:FooterType|(% style="width:434px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 272
273 **GenericMetadataType: **GenericMetadataType defines the contents of a generic metadata message.
274
275 Derivation:
276
Helena 3.6 277 * //MessageType// (restriction)
278 ** GenericMetadataType
Helena 2.2 279
280 Content:
281
282 Header, MetadataSet*, ftr:Footer?
283
284 Element Documentation:
285
Helena 3.6 286 (% style="width:836.294px" %)
287 |(% style="width:181px" %)**Name**|(% style="width:225px" %)**Type**|(% style="width:427px" %)**Documentation**
288 |(% style="width:181px" %)Header|(% style="width:225px" %)GenericMetadataHeade rType|(% style="width:427px" %)
289 |(% style="width:181px" %)MetadataSet|(% style="width:225px" %)rep:MetadataSetType|(% style="width:427px" %)
290 |(% style="width:181px" %)ftr:Footer|(% style="width:225px" %)ftr:FooterType|(% style="width:427px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 291
292 **StructureSpecificMetadataType: **StructureSpecificMetadataType defines the structure of a structure specific metadata message. Note that the metadata set payload type is abstract, and therefore it will have to be assigned a type in an instance. This type must be derived from the base type referenced. This base type defines a general structure which can be followed to allow for generic processing of the data even if the exact details of the data structure specific format are not known.
293
294 Derivation:
295
Helena 3.6 296 * //MessageType// (restriction)
297 ** StructureSpecificMetadataType
Helena 2.2 298
299 Content:
300
301 Header, MetadataSet*, ftr:Footer?
302
303 Element Documentation:
304
Helena 3.6 305 (% style="width:841.294px" %)
306 |(% style="width:160px" %)**Name**|(% style="width:250px" %)**Type**|(% style="width:428px" %)**Documentation**
307 |(% style="width:160px" %)Header|(% style="width:250px" %)StructureSpecificMet adataHeaderType|(% style="width:428px" %)
308 |(% style="width:160px" %)MetadataSet|(% style="width:250px" %)//msd:MetadataSetType//|(% style="width:428px" %)
309 |(% style="width:160px" %)ftr:Footer|(% style="width:250px" %)ftr:FooterType|(% style="width:428px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 310
311 **RegistryInterfaceType: **This is a type which describes a structure for holding all of the various dedicated registry interface message types.
312
313 Derivation:
314
Helena 3.6 315 * //MessageType// (restriction)
316 ** RegistryInterfaceType
Helena 2.2 317
318 Content:
319
320 Header, (SubmitRegistrationsRequest | SubmitRegistrationsResponse | QueryRegistrationRequest | QueryRegistrationResponse | SubmitStructureRequest | SubmitStructureResponse | SubmitSubscriptionsRequest | SubmitSubscriptionsResponse | QuerySubscriptionRequest | QuerySubscriptionResponse | NotifyRegistryEvent)?, ftr:Footer?
321
322 Element Documentation:
323
Helena 3.7 324 (% style="width:903.294px" %)
325 |**Name**|**Type**|(% style="width:441px" %)**Documentation**
326 |Header|BasicHeaderType|(% style="width:441px" %)
327 |SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|(% style="width:441px" %)SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
328 |SubmitRegistrationsR esponse|ref: SubmitRegistrationsR esponseType|(% style="width:441px" %)SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.
329 |QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|(% style="width:441px" %)QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.
330 |QueryRegistrationRes ponse|ref: QueryRegistrationRes ponseType|(% style="width:441px" %)QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.
331 |SubmitStructureReque st|ref: SubmitStructureReque stType|(% style="width:441px" %)SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.
332 |SubmitStructureRespo nse|ref: SubmitStructureRespo nseType|(% style="width:441px" %)SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.
333 |SubmitSubscriptionsR equest|ref: SubmitSubscriptionsR equestType|(% style="width:441px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
334 |SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|(% style="width:441px" %)SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.
335 |QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|(% style="width:441px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
336 |QuerySubscriptionRes ponse|ref: QuerySubscriptionRes ponseType|(% style="width:441px" %)QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.
337 |NotifyRegistryEvent|ref: NotifyRegistryEventT ype|(% style="width:441px" %)NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.
338 |ftr:Footer|ftr:FooterType|(% style="width:441px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 339
340 **SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the structure of a registry submit registration requests document.
341
342 Derivation:
343
Helena 3.7 344 * //MessageType// (restriction)
345 ** RegistryInterfaceType (restriction)
346 *** SubmitRegistrationsRequestType
Helena 2.2 347
348 Content:
349
Helena 4.2 350 Header, SubmitRegistrationsRequest
Helena 2.2 351
Helena 4.2 352 Element Documentation:
353
Helena 3.9 354 (% style="width:844.294px" %)
355 |**Name**|**Type**|(% style="width:377px" %)**Documentation**
356 |Header|BasicHeaderType|(% style="width:377px" %)
357 |SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|(% style="width:377px" %)SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
Helena 2.2 358
359 **SubmitRegistrationsResponseType: **SubmitRegistrationsResponseType defines the structure of a registry submit registration response document.
360
361 Derivation:
362
Helena 3.9 363 * //MessageType// (restriction)
364 ** RegistryInterfaceType (restriction)
365 *** SubmitRegistrationsResponseType
Helena 2.2 366
367 Content:
368
Helena 4.2 369 Header, SubmitRegistrationsResponse, ftr:Footer?
Helena 2.2 370
Helena 4.2 371 Element Documentation:
372
Helena 3.11 373 (% style="width:847.294px" %)
374 |**Name**|(% style="width:210px" %)**Type**|(% style="width:408px" %)**Documentation**
375 |Header|(% style="width:210px" %)BasicHeaderType|(% style="width:408px" %)
376 |SubmitRegistrationsR esponse|(% style="width:210px" %)ref: SubmitRegistrationsR esponseType|(% style="width:408px" %)SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.
377 |ftr:Footer|(% style="width:210px" %)ftr:FooterType|(% style="width:408px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 378
379 **QueryRegistrationRequestType: **QueryRegistrationRequestType defines the structure of a registry query registration request document.
380
381 Derivation:
382
Helena 3.11 383 * //MessageType// (restriction)
384 ** RegistryInterfaceType (restriction)
385 *** QueryRegistrationRequestType
Helena 2.2 386
387 Content:
388
Helena 4.2 389 Header, QueryRegistrationRequest
Helena 2.2 390
Helena 4.2 391 Element Documentation:
392
Helena 3.11 393 (% style="width:847.294px" %)
394 |**Name**|**Type**|(% style="width:397px" %)**Documentation**
395 |Header|BasicHeaderType|(% style="width:397px" %)
396 |QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|(% style="width:397px" %)QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.
Helena 2.2 397
398 **QueryRegistrationResponseType: **SubmitRegistrationRequestType defines the structure of a registry submit registration response document.
399
400 Derivation:
401
Helena 3.11 402 * //MessageType// (restriction)
403 ** RegistryInterfaceType (restriction)
404 *** QueryRegistrationResponseType
Helena 2.2 405
406 Content:
407
408 Header, QueryRegistrationResponse, ftr:Footer?
409
410 Element Documentation:
411
Helena 3.12 412 (% style="width:856.294px" %)
413 |**Name**|(% style="width:235px" %)**Type**|(% style="width:407px" %)**Documentation**
414 |Header|(% style="width:235px" %)BasicHeaderType|(% style="width:407px" %)
415 |QueryRegistrationRes ponse|(% style="width:235px" %)ref: QueryRegistrationRes ponseType|(% style="width:407px" %)QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.
416 |ftr:Footer|(% style="width:235px" %)ftr:FooterType|(% style="width:407px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 417
418 **SubmitStructureRequestType: **SubmitStructureRequestType defines the structure of a registry submit structure request document.
419
420 Derivation:
421
Helena 3.12 422 * //MessageType// (restriction)
423 ** RegistryInterfaceType (restriction)
424 *** SubmitStructureRequestType
Helena 2.2 425
426 Content:
427
428 Header, SubmitStructureRequest
429
430 Element Documentation:
431
Helena 3.13 432 (% style="width:870.294px" %)
433 |**Name**|**Type**|(% style="width:453px" %)**Documentation**
434 |Header|BasicHeaderType|(% style="width:453px" %)
435 |SubmitStructureReque st|ref: SubmitStructureReque stType|(% style="width:453px" %)SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.
Helena 2.2 436
437 **SubmitStructureResponseType: **SubmitStructureResponseType defines the structure of a registry submit registration response document.
438
439 Derivation:
440
Helena 3.13 441 * //MessageType// (restriction)
442 ** RegistryInterfaceType (restriction)
443 *** SubmitStructureResponseType
Helena 2.2 444
445 Content:
446
Helena 4.2 447 Header, SubmitStructureResponse, ftr:Footer?
Helena 2.2 448
Helena 4.2 449 Element Documentation:
450
Helena 3.13 451 (% style="width:835.294px" %)
452 |**Name**|(% style="width:246px" %)**Type**|(% style="width:366px" %)**Documentation**
453 |Header|(% style="width:246px" %)BasicHeaderType|(% style="width:366px" %)
454 |SubmitStructureRespo nse|(% style="width:246px" %)ref: SubmitStructureRespo nseType|(% style="width:366px" %)SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.
455 |ftr:Footer|(% style="width:246px" %)ftr:FooterType|(% style="width:366px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 456
457 **SubmitSubscriptionsRequestType: **SubmitSubscriptionsRequestType defines the structure of a registry submit subscription request document.
458
459 Derivation:
460
Helena 3.13 461 * //MessageType// (restriction)
462 ** RegistryInterfaceType (restriction)
463 *** SubmitSubscriptionsRequestType
Helena 2.2 464
465 Content:
466
Helena 4.2 467 Header, SubmitSubscriptionsRequest
Helena 2.2 468
Helena 4.2 469 Element Documentation:
470
Helena 3.14 471 (% style="width:832.294px" %)
472 |**Name**|(% style="width:227px" %)**Type**|(% style="width:319px" %)**Documentation**
473 |Header|(% style="width:227px" %)BasicHeaderType|(% style="width:319px" %)
474 |SubmitSubscriptionsR equest|(% style="width:227px" %)ref: SubmitSubscriptionsR equestType|(% style="width:319px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
Helena 2.2 475
476 **SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType defines the structure of a registry submit subscription response document.
477
478 Derivation:
479
Helena 3.14 480 * //MessageType// (restriction)
481 ** RegistryInterfaceType (restriction)
482 *** SubmitSubscriptionsResponseType
Helena 2.2 483
484 Content:
485
Helena 4.2 486 Header, SubmitSubscriptionsResponse, ftr:Footer?
Helena 2.2 487
Helena 4.2 488 Element Documentation:
489
Helena 3.15 490 (% style="width:843.294px" %)
491 |**Name**|**Type**|(% style="width:362px" %)**Documentation**
492 |Header|BasicHeaderType|(% style="width:362px" %)
493 |SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|(% style="width:362px" %)SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.
494 |ftr:Footer|ftr:FooterType|(% style="width:362px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 495
496 **QuerySubscriptionRequestType: **QuerySubscriptionRequestType defines the structure of a registry query subscription request document.
497
498 Derivation:
499
Helena 3.15 500 * //MessageType// (restriction)
501 ** RegistryInterfaceType (restriction)
502 *** QuerySubscriptionRequestType
Helena 2.2 503
504 Content:
505
Helena 4.2 506 Header, QuerySubscriptionRequest
Helena 2.2 507
Helena 4.2 508 Element Documentation:
509
Helena 3.16 510 (% style="width:839.294px" %)
511 |(% style="width:230px" %)**Name**|(% style="width:254px" %)**Type**|(% style="width:352px" %)**Documentation**
512 |(% style="width:230px" %)Header|(% style="width:254px" %)BasicHeaderType|(% style="width:352px" %)
513 |(% style="width:230px" %)QuerySubscriptionReq uest|(% style="width:254px" %)ref: QuerySubscriptionReq uestType|(% style="width:352px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
Helena 2.2 514
515 **QuerySubscriptionResponseType: **QuerySubscriptionResponseType defines the structure of a registry query subscription response document.
516
517 Derivation:
518
Helena 3.16 519 * //MessageType// (restriction)
520 ** RegistryInterfaceType (restriction)
521 *** QuerySubscriptionResponseType
Helena 2.2 522
523 Content:
524
Helena 4.2 525 Header, QuerySubscriptionResponse, ftr:Footer?
Helena 2.2 526
Helena 4.2 527 Element Documentation:
528
Helena 3.16 529 (% style="width:912.294px" %)
530 |**Name**|(% style="width:304px" %)**Type**|(% style="width:336px" %)**Documentation**
531 |Header|(% style="width:304px" %)BasicHeaderType|(% style="width:336px" %)
532 |QuerySubscriptionRes ponse|(% style="width:304px" %)ref: QuerySubscriptionRes ponseType|(% style="width:336px" %)QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.
533 |ftr:Footer|(% style="width:304px" %)ftr:FooterType|(% style="width:336px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 534
535 **NotifyRegistryEventType: **NotifyRegistryEventType defines the structure of a registry notification document.
536
537 Derivation:
538
Helena 3.16 539 * //MessageType// (restriction)
540 ** RegistryInterfaceType (restriction)
541 *** NotifyRegistryEventType
Helena 2.2 542
543 Content:
544
Helena 4.2 545 Header, NotifyRegistryEvent
Helena 2.2 546
Helena 4.2 547 Element Documentation:
548
Helena 3.16 549 (% style="width:836.294px" %)
550 |**Name**|**Type**|(% style="width:473px" %)**Documentation**
551 |Header|BasicHeaderType|(% style="width:473px" %)
552 |NotifyRegistryEvent|ref: NotifyRegistryEventT ype|(% style="width:473px" %)NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.
Helena 2.2 553
554 **DataQueryType: **DataQueryType defines the structure of a data query message.
555
556 Derivation:
557
Helena 3.16 558 * //MessageType// (restriction)
559 ** DataQueryType
Helena 2.2 560
561 Content:
562
Helena 4.2 563 Header, Query
Helena 2.2 564
Helena 4.2 565 Element Documentation:
566
Helena 3.16 567 (% style="width:839.294px" %)
568 |(% style="width:244px" %)**Name**|(% style="width:262px" %)**Type**|(% style="width:330px" %)**Documentation**
569 |(% style="width:244px" %)Header|(% style="width:262px" %)BasicHeaderType|(% style="width:330px" %)
570 |(% style="width:244px" %)Query|(% style="width:262px" %)qry:DataQueryType|(% style="width:330px" %)
Helena 2.2 571
572 **GenericDataQueryType: **DataQueryType defines the structure of a generic data query message.
573
574 Derivation:
575
Helena 3.16 576 * //MessageType// (restriction)
577 ** DataQueryType (restriction)
578 *** GenericDataQueryType
Helena 2.2 579
580 Content:
581
Helena 4.2 582 Header, Query
Helena 2.2 583
Helena 4.2 584 Element Documentation:
585
Helena 3.18 586 (% style="width:833.294px" %)
587 |(% style="width:213px" %)**Name**|(% style="width:243px" %)**Type**|(% style="width:374px" %)**Documentation**
588 |(% style="width:213px" %)Header|(% style="width:243px" %)BasicHeaderType|(% style="width:374px" %)
589 |(% style="width:213px" %)Query|(% style="width:243px" %)qry: GenericDataQueryType|(% style="width:374px" %)
Helena 2.2 590
591 **GenericTimeSeriesDataQueryType: **GenericTimeSeriesDataQueryType defines the structure of a time series generic data query message.
592
593 Derivation:
594
Helena 3.18 595 * //MessageType// (restriction)
596 ** DataQueryType (restriction)
597 *** GenericDataQueryType (restriction)
598 **** GenericTimeSeriesDataQueryType
Helena 2.2 599
600 Content:
601
Helena 4.2 602 Header, Query
Helena 2.2 603
Helena 4.2 604 Element Documentation:
605
Helena 3.19 606 (% style="width:909.294px" %)
607 |(% style="width:221px" %)**Name**|(% style="width:305px" %)**Type**|(% style="width:380px" %)**Documentation**
608 |(% style="width:221px" %)Header|(% style="width:305px" %)BasicHeaderType|(% style="width:380px" %)
609 |(% style="width:221px" %)Query|(% style="width:305px" %)qry: GenericTimeSeriesDat aQueryType|(% style="width:380px" %)
Helena 2.2 610
611 **StructureSpecificTimeSeriesDataQueryType: **StructureSpecificTimeSeriesDataQueryType defines the structure of a time series generic data query message.
612
613 Derivation:
614
Helena 3.19 615 * //MessageType// (restriction)
616 ** DataQueryType (restriction)
617 *** StructureSpecificTimeSeriesDataQueryType
Helena 2.2 618
619 Content:
620
Helena 4.2 621 Header, Query
Helena 2.2 622
Helena 4.2 623 Element Documentation:
624
Helena 3.20 625 (% style="width:903.294px" %)
626 |(% style="width:189px" %)**Name**|(% style="width:259px" %)**Type**|(% style="width:452px" %)**Documentation**
627 |(% style="width:189px" %)Header|(% style="width:259px" %)BasicHeaderType|(% style="width:452px" %)
628 |(% style="width:189px" %)Query|(% style="width:259px" %)qry: TimeSeriesDataQueryType|(% style="width:452px" %)
Helena 2.2 629
630 **MetadataQueryType: **MetadataQueryType defines the structure of a reference metadata query message.
631
632 Derivation:
633
Helena 3.20 634 * //MessageType// (restriction)
635 ** MetadataQueryType
Helena 2.2 636
637 Content:
638
Helena 4.2 639 Header, Query
Helena 2.2 640
Helena 4.2 641 Element Documentation:
642
Helena 3.21 643 (% style="width:858.294px" %)
644 |(% style="width:138px" %)**Name**|(% style="width:246px" %)**Type**|(% style="width:471px" %)**Documentation**
645 |(% style="width:138px" %)Header|(% style="width:246px" %)BasicHeaderType|(% style="width:471px" %)
646 |(% style="width:138px" %)Query|(% style="width:246px" %)qry: MetadataQueryType|(% style="width:471px" %)
Helena 2.2 647
648 **DataSchemaQueryType: **DataSchemaQueryType defines the structure of a data schema query message.
649
650 Derivation:
651
Helena 3.21 652 * //MessageType// (restriction)
653 ** DataSchemaQueryType
Helena 2.2 654
655 Content:
656
Helena 4.2 657 Header, Query
Helena 2.2 658
Helena 4.2 659 Element Documentation:
660
Helena 3.21 661 (% style="width:895.294px" %)
662 |(% style="width:185px" %)**Name**|(% style="width:294px" %)**Type**|(% style="width:413px" %)**Documentation**
663 |(% style="width:185px" %)Header|(% style="width:294px" %)BasicHeaderType|(% style="width:413px" %)
664 |(% style="width:185px" %)Query|(% style="width:294px" %)qry: DataSchemaQueryType|(% style="width:413px" %)
Helena 2.2 665
666 **MetadataSchemaQueryType: **MetadataSchemaQueryType defines the structure of a metadata schema query message.
667
668 Derivation:
669
Helena 3.21 670 * //MessageType// (restriction)
671 ** MetadataSchemaQueryType
Helena 2.2 672
673 Content:
674
Helena 4.2 675 Header, Query
Helena 2.2 676
Helena 4.2 677 Element Documentation:
678
Helena 3.21 679 (% style="width:897.294px" %)
680 |(% style="width:166px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:447px" %)**Documentation**
681 |(% style="width:166px" %)Header|(% style="width:281px" %)BasicHeaderType|(% style="width:447px" %)
682 |(% style="width:166px" %)Query|(% style="width:281px" %)qry: MetadataSchemaQueryType|(% style="width:447px" %)
Helena 2.2 683
684 **StructuresQueryType: **StructuresQueryType defines the structure of a structures query message.
685
686 Derivation:
687
Helena 3.21 688 * //MessageType// (restriction)
689 ** StructuresQueryType
Helena 2.2 690
691 Content:
692
Helena 4.2 693 Header, Query
Helena 2.2 694
Helena 4.2 695 Element Documentation:
696
Helena 3.22 697 (% style="width:886.294px" %)
698 |(% style="width:223px" %)**Name**|(% style="width:255px" %)**Type**|(% style="width:405px" %)**Documentation**
699 |(% style="width:223px" %)Header|(% style="width:255px" %)BasicHeaderType|(% style="width:405px" %)
700 |(% style="width:223px" %)Query|(% style="width:255px" %)qry: StructuresQueryType|(% style="width:405px" %)
Helena 2.2 701
702 **DataflowQueryType: **DataflowQueryType defines the structure of a dataflow query message.
703
704 Derivation:
705
Helena 3.22 706 * //MessageType// (restriction)
707 ** DataflowQueryType
Helena 2.2 708
709 Content:
710
Helena 4.2 711 Header, Query
Helena 2.2 712
Helena 4.2 713 Element Documentation:
714
Helena 3.22 715 (% style="width:888.294px" %)
716 |(% style="width:176px" %)**Name**|(% style="width:260px" %)**Type**|(% style="width:449px" %)**Documentation**
717 |(% style="width:176px" %)Header|(% style="width:260px" %)BasicHeaderType|(% style="width:449px" %)
718 |(% style="width:176px" %)Query|(% style="width:260px" %)qry: DataflowQueryType|(% style="width:449px" %)
Helena 2.2 719
720 **MetadataflowQueryType: **MetadataflowQueryType defines the structure of a metadata flow query message.
721
722 Derivation:
723
Helena 3.22 724 * //MessageType// (restriction)
725 ** MetadataflowQueryType
Helena 2.2 726
727 Content:
728
Helena 4.2 729 Header, Query
Helena 2.2 730
Helena 4.2 731 Element Documentation:
732
Helena 3.22 733 (% style="width:886.294px" %)
734 |(% style="width:199px" %)**Name**|(% style="width:296px" %)**Type**|(% style="width:388px" %)**Documentation**
735 |(% style="width:199px" %)Header|(% style="width:296px" %)BasicHeaderType|(% style="width:388px" %)
736 |(% style="width:199px" %)Query|(% style="width:296px" %)qry: MetadataflowQueryType|(% style="width:388px" %)
Helena 2.2 737
738 **DataStructureQueryType: **KeyFamilyQueryType defines the structure of a data structure query message.
739
740 Derivation:
741
Helena 3.22 742 * //MessageType// (restriction)
743 ** DataStructureQueryType
Helena 2.2 744
745 Content:
746
Helena 4.2 747 Header, Query
Helena 2.2 748
Helena 4.2 749 Element Documentation:
750
Helena 3.22 751 (% style="width:901.294px" %)
752 |(% style="width:202px" %)**Name**|(% style="width:303px" %)**Type**|(% style="width:393px" %)**Documentation**
753 |(% style="width:202px" %)Header|(% style="width:303px" %)BasicHeaderType|(% style="width:393px" %)
754 |(% style="width:202px" %)Query|(% style="width:303px" %)qry: DataStructureQueryType|(% style="width:393px" %)
Helena 2.2 755
756 **MetadataStructureQueryType: **MetadataStructureQueryType defines the structure of a metadata structure query message.
757
758 Derivation:
759
Helena 3.22 760 * //MessageType// (restriction)
761 ** MetadataStructureQueryType
Helena 2.2 762
763 Content:
764
Helena 4.2 765 Header, Query
Helena 2.2 766
Helena 4.2 767 Element Documentation:
768
Helena 3.22 769 (% style="width:904.294px" %)
770 |(% style="width:226px" %)**Name**|(% style="width:275px" %)**Type**|(% style="width:400px" %)**Documentation**
771 |(% style="width:226px" %)Header|(% style="width:275px" %)BasicHeaderType|(% style="width:400px" %)
772 |(% style="width:226px" %)Query|(% style="width:275px" %)qry: MetadataStructureQueryType|(% style="width:400px" %)
Helena 2.2 773
774 **CategorySchemeQueryType: **CategorySchemeQueryType defines the structure of a category scheme query message.
775
776 Derivation:
777
Helena 3.22 778 * //MessageType// (restriction)
779 ** CategorySchemeQueryType
Helena 2.2 780
781 Content:
782
Helena 4.2 783 Header, Query
Helena 2.2 784
Helena 4.2 785 Element Documentation:
786
Helena 3.22 787 (% style="width:915.294px" %)
788 |(% style="width:196px" %)**Name**|(% style="width:347px" %)**Type**|(% style="width:369px" %)**Documentation**
789 |(% style="width:196px" %)Header|(% style="width:347px" %)BasicHeaderType|(% style="width:369px" %)
790 |(% style="width:196px" %)Query|(% style="width:347px" %)qry: CategorySchemeQueryType|(% style="width:369px" %)
Helena 2.2 791
792 **ConceptSchemeQueryType: **ConceptSchemeQueryType defines the structure of a concept scheme query message.
793
794 Derivation:
795
Helena 3.22 796 * //MessageType// (restriction)
797 ** ConceptSchemeQueryType
Helena 2.2 798
799 Content:
800
Helena 4.2 801 Header, Query
Helena 2.2 802
Helena 4.2 803 Element Documentation:
804
Helena 3.22 805 (% style="width:895.294px" %)
806 |(% style="width:222px" %)**Name**|(% style="width:339px" %)**Type**|(% style="width:331px" %)**Documentation**
807 |(% style="width:222px" %)Header|(% style="width:339px" %)BasicHeaderType|(% style="width:331px" %)
808 |(% style="width:222px" %)Query|(% style="width:339px" %)qry: ConceptSchemeQueryType|(% style="width:331px" %)
Helena 2.2 809
810 **CodelistQueryType: **CodelistQueryType defines the structure of a codelist query message.
811
812 Derivation:
813
Helena 3.22 814 * //MessageType// (restriction)
815 ** CodelistQueryType
Helena 2.2 816
817 Content:
818
Helena 3.22 819 * Header, Query
820 * Element Documentation:
Helena 2.2 821
Helena 3.22 822 (% style="width:911.294px" %)
823 |(% style="width:204px" %)**Name**|(% style="width:295px" %)**Type**|(% style="width:409px" %)**Documentation**
824 |(% style="width:204px" %)Header|(% style="width:295px" %)BasicHeaderType|(% style="width:409px" %)
825 |(% style="width:204px" %)Query|(% style="width:295px" %)qry:CodelistQueryType|(% style="width:409px" %)
Helena 2.2 826
827 **HierarchicalCodelistQueryType: **HierarchicalCodelistQueryType defines the structure of a hierarchical codelist query message.
828
829 Derivation:
830
Helena 3.23 831 * //MessageType// (restriction)
832 ** HierarchicalCodelistQueryType
Helena 2.2 833
834 Content:
835
Helena 3.23 836 * Header, Query
837 * Element Documentation:
Helena 2.2 838
Helena 3.23 839 (% style="width:906.294px" %)
840 |(% style="width:191px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:430px" %)**Documentation**
841 |(% style="width:191px" %)Header|(% style="width:281px" %)BasicHeaderType|(% style="width:430px" %)
842 |(% style="width:191px" %)Query|(% style="width:281px" %)qry: HierarchicalCodelist QueryType|(% style="width:430px" %)
Helena 2.2 843
844 **OrganisationSchemeQueryType: **OrganisationSchemeQueryType defines the structure of an organisation scheme query message.
845
846 Derivation:
847
Helena 3.23 848 * //MessageType// (restriction)
849 ** OrganisationSchemeQueryType
Helena 2.2 850
851 Content:
852
Helena 3.23 853 * Header, Query
854 * Element Documentation:
Helena 2.2 855
Helena 3.23 856 (% style="width:891.294px" %)
857 |(% style="width:174px" %)**Name**|(% style="width:292px" %)**Type**|(% style="width:422px" %)**Documentation**
858 |(% style="width:174px" %)Header|(% style="width:292px" %)BasicHeaderType|(% style="width:422px" %)
859 |(% style="width:174px" %)Query|(% style="width:292px" %)qry: OrganisationSchemeQueryType|(% style="width:422px" %)
Helena 2.2 860
861 **ReportingTaxonomyQueryType: **ReportingTaxonomyQueryType defines the structure of a reporting taxonomy query message.
862
863 Derivation:
864
Helena 3.23 865 * //MessageType// (restriction)
866 ** ReportingTaxonomyQueryType
Helena 2.2 867
868 Content:
869
Helena 3.23 870 * Header, Query
871 * Element Documentation:
Helena 2.2 872
Helena 3.23 873 (% style="width:916.294px" %)
874 |(% style="width:162px" %)**Name**|(% style="width:318px" %)**Type**|(% style="width:434px" %)**Documentation**
875 |(% style="width:162px" %)Header|(% style="width:318px" %)BasicHeaderType|(% style="width:434px" %)
876 |(% style="width:162px" %)Query|(% style="width:318px" %)qry: ReportingTaxonomyQueryType|(% style="width:434px" %)
Helena 2.2 877
878 **StructureSetQueryType: **StructureSetQueryType defines the structure of a structure set query message.
879
880 Derivation:
881
Helena 3.23 882 * //MessageType// (restriction)
883 ** StructureSetQueryType
Helena 2.2 884
885 Content:
886
Helena 3.23 887 * Header, Query
888 * Element Documentation:
Helena 2.2 889
Helena 3.23 890 (% style="width:896.294px" %)
891 |(% style="width:182px" %)**Name**|(% style="width:294px" %)**Type**|(% style="width:417px" %)**Documentation**
892 |(% style="width:182px" %)Header|(% style="width:294px" %)BasicHeaderType|(% style="width:417px" %)
893 |(% style="width:182px" %)Query|(% style="width:294px" %)qry: StructureSetQueryType|(% style="width:417px" %)
Helena 2.2 894
895 **ProcessQueryType: **CategorizationQueryType defines the structure of a categorization query message.
896
897 Derivation:
898
Helena 3.23 899 * //MessageType// (restriction)
900 ** ProcessQueryType
Helena 2.2 901
902 Content:
903
Helena 3.23 904 * Header, Query
905 * Element Documentation:
Helena 2.2 906
Helena 3.23 907 (% style="width:907.294px" %)
908 |(% style="width:189px" %)**Name**|(% style="width:394px" %)**Type**|(% style="width:321px" %)**Documentation**
909 |(% style="width:189px" %)Header|(% style="width:394px" %)BasicHeaderType|(% style="width:321px" %)
910 |(% style="width:189px" %)Query|(% style="width:394px" %)qry:ProcessQueryType|(% style="width:321px" %)
Helena 2.2 911
912 **CategorisationQueryType: **CategorisationQueryType defines the structure of a categorisation query message.
913
914 Derivation:
915
Helena 3.23 916 * //MessageType// (restriction)
917 ** CategorisationQueryType
Helena 2.2 918
919 Content:
920
Helena 3.23 921 * Header, Query
922 * Element Documentation:
Helena 2.2 923
Helena 3.23 924 (% style="width:897.294px" %)
925 |(% style="width:230px" %)**Name**|(% style="width:300px" %)**Type**|(% style="width:363px" %)**Documentation**
926 |(% style="width:230px" %)Header|(% style="width:300px" %)BasicHeaderType|(% style="width:363px" %)
927 |(% style="width:230px" %)Query|(% style="width:300px" %)qry: CategorisationQueryType|(% style="width:363px" %)
Helena 2.2 928
929 **ProvisionAgreementQueryType: **ProvisionAgreementQueryType defines the structure of a provision agreement query message.
930
931 Derivation:
932
Helena 3.23 933 * //MessageType// (restriction)
934 ** ProvisionAgreementQueryType
Helena 2.2 935
936 Content:
937
Helena 3.23 938 * Header, Query
939 * Element Documentation:
Helena 2.2 940
Helena 3.23 941 (% style="width:902.294px" %)
942 |(% style="width:142px" %)**Name**|(% style="width:339px" %)**Type**|(% style="width:418px" %)**Documentation**
943 |(% style="width:142px" %)Header|(% style="width:339px" %)BasicHeaderType|(% style="width:418px" %)
944 |(% style="width:142px" %)Query|(% style="width:339px" %)qry: ProvisionAgreementQueryType|(% style="width:418px" %)
Helena 2.2 945
946 **ConstraintQueryType: **ConstraintQueryType defines the structure of a constraint query message.
947
948 Derivation:
949
Helena 3.24 950 * //MessageType// (restriction)
951 ** ConstraintQueryType
Helena 2.2 952
953 Content:
954
Helena 3.24 955 * Header, Query
956 * Element Documentation:
Helena 2.2 957
Helena 3.24 958 (% style="width:902.294px" %)
959 |(% style="width:167px" %)**Name**|(% style="width:287px" %)**Type**|(% style="width:445px" %)**Documentation**
960 |(% style="width:167px" %)Header|(% style="width:287px" %)BasicHeaderType|(% style="width:445px" %)
961 |(% style="width:167px" %)Query|(% style="width:287px" %)qry: ConstraintQueryType|(% style="width:445px" %)
Helena 2.2 962
963 **TransformationSchemeQueryType: **TransformationSchemeQueryType defines the structure of a transformation scheme query message.
964
965 Derivation:
966
Helena 3.24 967 * //MessageType// (restriction)
968 ** TransformationSchemeQueryType
Helena 2.2 969
970 Content:
971
Helena 3.24 972 * Header, Query
973 * Element Documentation:
Helena 2.2 974
Helena 3.24 975 (% style="width:833.294px" %)
976 |(% style="width:165px" %)**Name**|(% style="width:325px" %)**Type**|(% style="width:340px" %)**Documentation**
977 |(% style="width:165px" %)Header|(% style="width:325px" %)BasicHeaderType|(% style="width:340px" %)
978 |(% style="width:165px" %)Query|(% style="width:325px" %)qry: TransformationSchemeQueryType|(% style="width:340px" %)
Helena 2.2 979
980 **VtlMappingSchemeQueryType: **VtlMappingSchemeQueryType defines the structure of a VTL mappings scheme query message.
981
982 Derivation:
983
Helena 3.24 984 * //MessageType// (restriction)
985 ** VtlMappingSchemeQueryType
Helena 2.2 986
987 Content:
988
Helena 3.24 989 * Header, Query
990 * Element Documentation:
Helena 2.2 991
Helena 3.24 992 (% style="width:843.294px" %)
993 |(% style="width:164px" %)**Name**|(% style="width:303px" %)**Type**|(% style="width:373px" %)**Documentation**
994 |(% style="width:164px" %)Header|(% style="width:303px" %)BasicHeaderType|(% style="width:373px" %)
995 |(% style="width:164px" %)Query|(% style="width:303px" %)qry: VtlMappingSchemeQueryType|(% style="width:373px" %)
Helena 2.2 996
997 **NamePersonalisationSchemeQueryType: **NamePersonalisationSchemeQueryType defines the structure of a name personalisation scheme query message.
998
999 Derivation:
1000
Helena 3.24 1001 * //MessageType// (restriction)
1002 ** NamePersonalisationSchemeQueryType
Helena 2.2 1003
1004 Content:
1005
Helena 3.24 1006 * Header, Query
1007 * Element Documentation:
Helena 2.2 1008
Helena 3.24 1009 (% style="width:895.294px" %)
1010 |(% style="width:186px" %)**Name**|(% style="width:363px" %)**Type**|(% style="width:343px" %)**Documentation**
1011 |(% style="width:186px" %)Header|(% style="width:363px" %)BasicHeaderType|(% style="width:343px" %)
1012 |(% style="width:186px" %)Query|(% style="width:363px" %)qry: NamePersonalisationSchemeQueryType|(% style="width:343px" %)
Helena 2.2 1013
1014 **RulesetSchemeQueryType: **RulesetSchemeQueryType defines the structure of a ruleset scheme query message.
1015
1016 Derivation:
1017
Helena 3.24 1018 * //MessageType// (restriction)
1019 ** RulesetSchemeQueryType
Helena 2.2 1020
1021 Content:
1022
Helena 3.24 1023 * Header, Query
1024 * Element Documentation:
Helena 2.2 1025
Helena 3.24 1026 (% style="width:886.294px" %)
1027 |(% style="width:152px" %)**Name**|(% style="width:311px" %)**Type**|(% style="width:420px" %)**Documentation**
1028 |(% style="width:152px" %)Header|(% style="width:311px" %)BasicHeaderType|(% style="width:420px" %)
1029 |(% style="width:152px" %)Query|(% style="width:311px" %)qry: RulesetSchemeQueryType|(% style="width:420px" %)
Helena 2.2 1030
1031 **UserDefinedOperatorSchemeQueryType: **UserDefinedOperatorSchemeQueryType defines the structure of a user defined operator scheme query message.
1032
1033 Derivation:
1034
Helena 3.24 1035 * //MessageType// (restriction)
1036 ** UserDefinedOperatorSchemeQueryType
Helena 2.2 1037
1038 Content:
1039
Helena 3.24 1040 * Header, Query
1041 * Element Documentation:
Helena 2.2 1042
Helena 3.24 1043 (% style="width:866.294px" %)
1044 |(% style="width:174px" %)**Name**|(% style="width:358px" %)**Type**|(% style="width:331px" %)**Documentation**
1045 |(% style="width:174px" %)Header|(% style="width:358px" %)BasicHeaderType|(% style="width:331px" %)
1046 |(% style="width:174px" %)Query|(% style="width:358px" %)qry: UserDefinedOperatorSchemeQueryType|(% style="width:331px" %)
Helena 2.2 1047
1048 **CustomTypeSchemeQueryType: **CustomTypeSchemeQueryType defines the structure of a custom type scheme query message.
1049
1050 Derivation:
1051
Helena 3.24 1052 * //MessageType// (restriction)
1053 ** CustomTypeSchemeQueryType
Helena 2.2 1054
1055 Content:
1056
Helena 3.24 1057 * Header, Query
1058 * Element Documentation:
Helena 2.2 1059
Helena 3.24 1060 (% style="width:828.294px" %)
1061 |(% style="width:200px" %)**Name**|(% style="width:308px" %)**Type**|(% style="width:317px" %)**Documentation**
1062 |(% style="width:200px" %)Header|(% style="width:308px" %)BasicHeaderType|(% style="width:317px" %)
1063 |(% style="width:200px" %)Query|(% style="width:308px" %)qry: CustomTypeSchemeQueryType|(% style="width:317px" %)
Helena 2.2 1064
1065 **ErrorType: **ErrorType describes the structure of an error response.
1066
1067 Content:
1068
Helena 3.24 1069 * ErrorMessage+
1070 * Element Documentation:
Helena 2.2 1071
Helena 3.24 1072 (% style="width:899.294px" %)
1073 |**Name**|**Type**|(% style="width:546px" %)**Documentation**
1074 |ErrorMessage|com: CodedStatusMessageTy pe|(% style="width:546px" %)ErrorMessage contains the error message. It can occur multiple times to communicate message for multiple errors, or to communicate the error message in parallel languages. If both messages for multiple errors and parallel language messages are used, then each error message should be given a code in order to distinguish message for unique errors.
Helena 2.2 1075
1076 **//BaseHeaderType//: **BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this
1077
1078 Content:
1079
1080 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure*, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1081
1082 Element Documentation:
1083
Helena 3.24 1084 (% style="width:891.294px" %)
1085 |**Name**|**Type**|(% style="width:552px" %)**Documentation**
1086 |ID|com:IDType|(% style="width:552px" %)ID identifies an identification for the message, assigned by the sender.
1087 |Test|xs:boolean|(% style="width:552px" %)Test indicates whether the message is for test purposes or not.
1088 |Prepared|HeaderTimeType|(% style="width:552px" %)Prepared is the date the message was prepared.
1089 |Sender|SenderType|(% style="width:552px" %)Sender is information about the party that is transmitting the message.
1090 |Receiver|PartyType|(% style="width:552px" %)Receiver is information about the party that is the intended recipient of the message.
1091 |com:Name|com:TextType|(% style="width:552px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1092 |Structure|//com: PayloadStructureType//|(% style="width:552px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
1093 |DataProvider|com: DataProviderReferenceType|(% style="width:552px" %)DataProvider identifies the provider of the data for a data/reference metadata message.
1094 |DataSetAction|com:ActionType|(% style="width:552px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
1095 |DataSetID|com:IDType|(% style="width:552px" %)DataSetID provides an identifier for a contained data set.
1096 |Extracted|xs:dateTime|(% style="width:552px" %)Extracted is a time-stamp from the system rendering the data.
1097 |ReportingBegin|com: ObservationalTimePeriodType|(% style="width:552px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
1098 |ReportingEnd|com: ObservationalTimePeriodType|(% style="width:552px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
1099 |EmbargoDate|xs:dateTime|(% style="width:552px" %)EmbargoDate holds a time period before which the data included in this message is not available.
1100 |Source|com:TextType|(% style="width:552px" %)Source provides human-readable information about the source of the data.
Helena 2.2 1101
1102 **StructureHeaderType: **StructureHeaderType defines the structure for structural metadata messages.
1103
1104 Derivation:
1105
Helena 3.24 1106 * //BaseHeaderType// (restriction)
1107 ** StructureHeaderType
Helena 2.2 1108
1109 Content:
1110
1111 ID, Test, Prepared, Sender, Receiver*, com:Name*, Source*
1112
1113 Element Documentation:
1114
Helena 3.24 1115 (% style="width:1099.29px" %)
1116 |**Name**|(% style="width:224px" %)**Type**|(% style="width:663px" %)**Documentation**
1117 |ID|(% style="width:224px" %)com:IDType|(% style="width:663px" %)ID identifies an identification for the message, assigned by the sender.
1118 |Test|(% style="width:224px" %)xs:boolean|(% style="width:663px" %)Test indicates whether the message is for test purposes or not.
1119 |Prepared|(% style="width:224px" %)HeaderTimeType|(% style="width:663px" %)Prepared is the date the message was prepared.
1120 |Sender|(% style="width:224px" %)SenderType|(% style="width:663px" %)Sender is information about the party that is transmitting the message.
1121 |Receiver|(% style="width:224px" %)PartyType|(% style="width:663px" %)Receiver is information about the party that is the intended recipient of the message.
1122 |com:Name|(% style="width:224px" %)com:TextType|(% style="width:663px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1123 |Source|(% style="width:224px" %)com:TextType|(% style="width:663px" %)Source provides human-readable information about the source of the data.
Helena 2.2 1124
1125 **GenericDataHeaderType: **GenericDataHeaderType defines the header structure for a generic data message.
1126
1127 Derivation:
1128
Helena 3.24 1129 * //BaseHeaderType// (restriction)
Helena 3.25 1130 ** GenericDataHeaderType
Helena 2.2 1131
1132 Content:
1133
1134 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1135
1136 Element Documentation:
1137
Helena 3.25 1138 (% style="width:895.294px" %)
1139 |**Name**|**Type**|(% style="width:556px" %)**Documentation**
1140 |ID|com:IDType|(% style="width:556px" %)ID identifies an identification for the message, assigned by the sender.
1141 |Test|xs:boolean|(% style="width:556px" %)Test indicates whether the message is for test purposes or not.
1142 |Prepared|HeaderTimeType|(% style="width:556px" %)Prepared is the date the message was prepared.
1143 |Sender|SenderType|(% style="width:556px" %)Sender is information about the party that is transmitting the message.
1144 |Receiver|PartyType|(% style="width:556px" %)Receiver is information about the party that is the intended recipient of the message.
1145 |com:Name|com:TextType|(% style="width:556px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1146 |Structure|com: GenericDataStructureType|(% style="width:556px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
1147 |DataProvider|com: DataProviderReferenceType|(% style="width:556px" %)DataProvider identifies the provider of the data for a data/reference metadata message.
1148 |DataSetAction|com:ActionType|(% style="width:556px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
1149 |DataSetID|com:IDType|(% style="width:556px" %)DataSetID provides an identifier for a contained data set.
1150 |Extracted|xs:dateTime|(% style="width:556px" %)Extracted is a time-stamp from the system rendering the data.
1151 |ReportingBegin|com: ObservationalTimePeriodType|(% style="width:556px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
1152 |ReportingEnd|com: ObservationalTimePeriodType|(% style="width:556px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
1153 |EmbargoDate|xs:dateTime|(% style="width:556px" %)EmbargoDate holds a time period before which the data included in this message is not available.
1154 |Source|com:TextType|(% style="width:556px" %)Source provides human-readable information about the source of the data.
Helena 2.2 1155
1156 **GenericTimeSeriesDataHeaderType: **GenericTimeSeriesDataHeaderType defines the header structure for a time series only generic data message.
1157
1158 Derivation:
1159
Helena 3.25 1160 * //BaseHeaderType// (restriction)
1161 ** GenericDataHeaderType (restriction)
1162 *** GenericTimeSeriesDataHeaderType
Helena 2.2 1163
1164 Content:
1165
1166 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1167
1168 Element Documentation:
1169
Helena 3.26 1170 (% style="width:926.294px" %)
1171 |**Name**|**Type**|(% style="width:497px" %)**Documentation**
1172 |ID|com:IDType|(% style="width:497px" %)ID identifies an identification for the message, assigned by the sender.
1173 |Test|xs:boolean|(% style="width:497px" %)Test indicates whether the message is for test purposes or not.
1174 |Prepared|HeaderTimeType|(% style="width:497px" %)Prepared is the date the message was prepared.
1175 |Sender|SenderType|(% style="width:497px" %)Sender is information about the party that is transmitting the message.
1176 |Receiver|PartyType|(% style="width:497px" %)Receiver is information about the party that is the intended recipient of the message.
1177 |com:Name|com:TextType|(% style="width:497px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1178 |Structure|com: GenericTimeSeriesDataStructureType|(% style="width:497px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
1179 |DataProvider|com: DataProviderReferenceType|(% style="width:497px" %)DataProvider identifies the provider of the data for a data/reference metadata message.
1180 |DataSetAction|com:ActionType|(% style="width:497px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
1181 |DataSetID|com:IDType|(% style="width:497px" %)DataSetID provides an identifier for a contained data set.
1182 |Extracted|xs:dateTime|(% style="width:497px" %)Extracted is a time-stamp from the system rendering the data.
1183 |ReportingBegin|com: ObservationalTimePeriodType|(% style="width:497px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
1184 |ReportingEnd|com: ObservationalTimePeriodType|(% style="width:497px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
1185 |EmbargoDate|xs:dateTime|(% style="width:497px" %)EmbargoDate holds a time period before which the data included in this message is not available.
1186 |Source|com:TextType|(% style="width:497px" %)Source provides human-readable information about the source of the data.
Helena 2.2 1187
1188 **StructureSpecificDataHeaderType: **StructureSpecificDataHeaderType defines the header structure for a structure specific data message.
1189
1190 Derivation:
1191
Helena 3.26 1192 * //BaseHeaderType// (restriction)
1193 ** StructureSpecificDataHeaderType
Helena 2.2 1194
1195 Content:
1196
1197 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1198
1199 Element Documentation:
1200
Helena 3.26 1201 (% style="width:930.294px" %)
1202 |**Name**|**Type**|(% style="width:578px" %)**Documentation**
1203 |ID|com:IDType|(% style="width:578px" %)ID identifies an identification for the message, assigned by the sender.
1204 |Test|xs:boolean|(% style="width:578px" %)Test indicates whether the message is for test purposes or not.
1205 |Prepared|HeaderTimeType|(% style="width:578px" %)Prepared is the date the message was prepared.
1206 |Sender|SenderType|(% style="width:578px" %)Sender is information about the party that is transmitting the message.
1207 |Receiver|PartyType|(% style="width:578px" %)Receiver is information about the party that is the intended recipient of the message.
1208 |com:Name|com:TextType|(% style="width:578px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1209 |Structure|com: StructureSpecificDataStructureType|(% style="width:578px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
1210 |DataProvider|com: DataProviderReferenceType|(% style="width:578px" %)DataProvider identifies the provider of the data for a data/reference metadata message.
1211 |DataSetAction|com:ActionType|(% style="width:578px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
1212 |DataSetID|com:IDType|(% style="width:578px" %)DataSetID provides an identifier for a contained data set.
1213 |Extracted|xs:dateTime|(% style="width:578px" %)Extracted is a time-stamp from the system rendering the data.
1214 |ReportingBegin|com: ObservationalTimePeriodType|(% style="width:578px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
1215 |ReportingEnd|com: ObservationalTimePeriodType|(% style="width:578px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
1216 |EmbargoDate|xs:dateTime|(% style="width:578px" %)EmbargoDate holds a time period before which the data included in this message is not available.
1217 |Source|com:TextType|(% style="width:578px" %)Source provides human-readable information about the source of the data.
Helena 2.2 1218
1219 **StructureSpecificTimeSeriesDataHeaderType: **StructureSpecificTimeSeriesDataHeaderType defines the header structure for a time series only structure specific data message.
1220
1221 Derivation:
1222
Helena 3.27 1223 * //BaseHeaderType// (restriction)
1224 ** StructureSpecificDataHeaderType (restriction)
1225 *** StructureSpecificTimeSeriesDataHeaderType
Helena 2.2 1226
1227 Content:
1228
1229 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1230
1231 Element Documentation:
1232
Helena 3.28 1233 (% style="width:943.294px" %)
1234 |**Name**|(% style="width:352px" %)**Type**|(% style="width:461px" %)**Documentation**
1235 |ID|(% style="width:352px" %)com:IDType|(% style="width:461px" %)ID identifies an identification for the message, assigned by the sender.
1236 |Test|(% style="width:352px" %)xs:boolean|(% style="width:461px" %)Test indicates whether the message is for test purposes or not.
1237 |Prepared|(% style="width:352px" %)HeaderTimeType|(% style="width:461px" %)Prepared is the date the message was prepared.
1238 |Sender|(% style="width:352px" %)SenderType|(% style="width:461px" %)Sender is information about the party that is transmitting the message.
1239 |Receiver|(% style="width:352px" %)PartyType|(% style="width:461px" %)Receiver is information about the party that is the intended recipient of the message.
1240 |com:Name|(% style="width:352px" %)com:TextType|(% style="width:461px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1241 |Structure|(% style="width:352px" %)com: StructureSpecificDataTimeSeriesStructureType|(% style="width:461px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
1242 |DataProvider|(% style="width:352px" %)com: DataProviderReferenceType|(% style="width:461px" %)DataProvider identifies the provider of the data for a data/reference metadata message.
1243 |DataSetAction|(% style="width:352px" %)com:ActionType|(% style="width:461px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
1244 |DataSetID|(% style="width:352px" %)com:IDType|(% style="width:461px" %)DataSetID provides an identifier for a contained data set.
1245 |Extracted|(% style="width:352px" %)xs:dateTime|(% style="width:461px" %)Extracted is a time-stamp from the system rendering the data.
1246 |ReportingBegin|(% style="width:352px" %)com: ObservationalTimePeriodType|(% style="width:461px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
1247 |ReportingEnd|(% style="width:352px" %)com: ObservationalTimePeriodType|(% style="width:461px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
1248 |EmbargoDate|(% style="width:352px" %)xs:dateTime|(% style="width:461px" %)EmbargoDate holds a time period before which the data included in this message is not available.
1249 |Source|(% style="width:352px" %)com:TextType|(% style="width:461px" %)Source provides human-readable information about the source of the data.
Helena 2.2 1250
1251 **GenericMetadataHeaderType: **GenericMetadataHeaderType defines the header format for generic reference metadata.
1252
1253 Derivation:
1254
Helena 3.28 1255 * //BaseHeaderType// (restriction)
1256 ** GenericMetadataHeaderType
Helena 2.2 1257
1258 Content:
1259
1260 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, Source*
1261
1262 Element Documentation:
1263
Helena 3.28 1264 (% style="width:928.294px" %)
1265 |**Name**|**Type**|(% style="width:554px" %)**Documentation**
1266 |ID|com:IDType|(% style="width:554px" %)ID identifies an identification for the message, assigned by the sender.
1267 |Test|xs:boolean|(% style="width:554px" %)Test indicates whether the message is for test purposes or not.
1268 |Prepared|HeaderTimeType|(% style="width:554px" %)Prepared is the date the message was prepared.
1269 |Sender|SenderType|(% style="width:554px" %)Sender is information about the party that is transmitting the message.
1270 |Receiver|PartyType|(% style="width:554px" %)Receiver is information about the party that is the intended recipient of the message.
1271 |com:Name|com:TextType|(% style="width:554px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1272 |Structure|com: GenericMetadataStructureType|(% style="width:554px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
1273 |DataProvider|com: DataProviderReferenceType|(% style="width:554px" %)DataProvider identifies the provider of the data for a data/reference metadata message.
1274 |DataSetAction|com:ActionType|(% style="width:554px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
1275 |DataSetID|com:IDType|(% style="width:554px" %)DataSetID provides an identifier for a contained data set.
1276 |Extracted|xs:dateTime|(% style="width:554px" %)Extracted is a time-stamp from the system rendering the data.
1277 |Source|com:TextType|(% style="width:554px" %)Source provides human-readable information about the source of the data.
Helena 2.2 1278
1279 **StructureSpecificMetadataHeaderType: **StructureSpecificMetadataHeaderType defines the header format for metadata structure definition specific reference metadata messages.
1280
1281 Derivation:
1282
Helena 3.28 1283 * //BaseHeaderType// (restriction)
1284 ** StructureSpecificMetadataHeaderType
Helena 2.2 1285
1286 Content:
1287
1288 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, Source*
1289
1290 Element Documentation:
1291
Helena 3.28 1292 (% style="width:996.294px" %)
1293 |**Name**|**Type**|(% style="width:557px" %)**Documentation**
1294 |ID|com:IDType|(% style="width:557px" %)ID identifies an identification for the message, assigned by the sender.
1295 |Test|xs:boolean|(% style="width:557px" %)Test indicates whether the message is for test purposes or not.
1296 |Prepared|HeaderTimeType|(% style="width:557px" %)Prepared is the date the message was prepared.
1297 |Sender|SenderType|(% style="width:557px" %)Sender is information about the party that is transmitting the message.
1298 |Receiver|PartyType|(% style="width:557px" %)Receiver is information about the party that is the intended recipient of the message.
1299 |com:Name|com:TextType|(% style="width:557px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
1300 |Structure|com: StructureSpecificMetadataStructureType|(% style="width:557px" %)Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.
1301 |DataProvider|com: DataProviderReferenceType|(% style="width:557px" %)DataProvider identifies the provider of the data for a data/reference metadata message.
1302 |DataSetAction|com:ActionType|(% style="width:557px" %)DataSetAction code provides a code for determining whether the enclosed message is an Update or Delete message (not to be used with the UtilityData message).
1303 |DataSetID|com:IDType|(% style="width:557px" %)DataSetID provides an identifier for a contained data set.
1304 |Extracted|xs:dateTime|(% style="width:557px" %)Extracted is a time-stamp from the system rendering the data.
1305 |Source|com:TextType|(% style="width:557px" %)Source provides human-readable information about the source of the data.
Helena 2.2 1306
1307 **BasicHeaderType: **BasicHeaderType defines the most basic header information used in simple message exchanges.
1308
1309 Derivation:
1310
Helena 3.28 1311 * //BaseHeaderType// (restriction)
1312 ** BasicHeaderType
Helena 2.2 1313
1314 Content:
1315
1316 ID, Test, Prepared, Sender, Receiver
1317
1318 Element Documentation:
1319
Helena 3.29 1320 (% style="width:903.294px" %)
1321 |**Name**|(% style="width:236px" %)**Type**|(% style="width:457px" %)**Documentation**
1322 |ID|(% style="width:236px" %)com:IDType|(% style="width:457px" %)ID identifies an identification for the message, assigned by the sender.
1323 |Test|(% style="width:236px" %)xs:boolean|(% style="width:457px" %)Test indicates whether the message is for test purposes or not.
1324 |Prepared|(% style="width:236px" %)HeaderTimeType|(% style="width:457px" %)Prepared is the date the message was prepared.
1325 |Sender|(% style="width:236px" %)SenderType|(% style="width:457px" %)Sender is information about the party that is transmitting the message.
1326 |Receiver|(% style="width:236px" %)PartyType|(% style="width:457px" %)Receiver is information about the party that is the intended recipient of the message.
Helena 2.2 1327
1328 **PartyType: **PartyType defines the information which is sent about various parties such as senders and receivers of messages.
1329
1330 Attributes:
1331
1332 id
1333
1334 Content:
1335
1336 com:Name*, Contact*
1337
1338 Attribute Documentation:
1339
Helena 3.29 1340 (% style="width:739.294px" %)
1341 |(% style="width:125px" %)**Name**|(% style="width:190px" %)**Type**|(% style="width:421px" %)**Documentation**
1342 |(% style="width:125px" %)id|(% style="width:190px" %)com:IDType|(% style="width:421px" %)The id attribute holds the identification of the party.
Helena 2.2 1343
1344 Element Documentation:
1345
Helena 3.29 1346 (% style="width:751.294px" %)
1347 |(% style="width:134px" %)**Name**|(% style="width:183px" %)**Type**|(% style="width:431px" %)**Documentation**
1348 |(% style="width:134px" %)com:Name|(% style="width:183px" %)com:TextType|(% style="width:431px" %)Name is a human-readable name of the party.
1349 |(% style="width:134px" %)Contact|(% style="width:183px" %)ContactType|(% style="width:431px" %)Contact provides contact information for the party in regard to the transmission of the message.
Helena 2.2 1350
1351 **SenderType: **SenderType extends the basic party structure to add an optional time zone declaration.
1352
1353 Derivation:
1354
Helena 3.29 1355 * PartyType (extension)
1356 ** SenderType
Helena 2.2 1357
1358 Attributes:
1359
1360 id
1361
1362 Content:
1363
1364 com:Name*, Contact*, Timezone?
1365
1366 Attribute Documentation:
1367
Helena 4.1 1368 (% style="width:824.294px" %)
1369 |(% style="width:177px" %)**Name**|(% style="width:241px" %)**Type**|(% style="width:403px" %)**Documentation**
1370 |(% style="width:177px" %)id|(% style="width:241px" %)com:IDType|(% style="width:403px" %)The id attribute holds the identification of the party.
Helena 2.2 1371
1372 Element Documentation:
1373
1374 |**Name**|**Type**|**Documentation**
1375 |com:Name|com:TextType|Name is a human-readable name of the party.
1376 |Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.
1377 |Timezone|com:TimezoneType|Timezone specifies the time zone of the sender, and if specified can be applied to all un-time zoned time values in the message. In the absence of this, any dates without time zone are implied to be in an indeterminate "local time".
1378
1379 **ContactType: **ContactType provides defines the contact information about a party.
1380
1381 Content:
1382
1383 com:Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)*
1384
1385 Element Documentation:
1386
1387 |**Name**|**Type**|**Documentation**
1388 |com:Name|com:TextType|Name contains a human-readable name for the contact.
1389 |Department|com:TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.
1390 |Role|com:TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.
1391 |Telephone|xs:string|Telephone holds the telephone number for the contact person.
1392 |Fax|xs:string|Fax holds the fax number for the contact person.
1393 |X400|xs:string|X400 holds the X.400 address for the contact person.
1394 |URI|xs:anyURI|URI holds an information URL for the contact person.
1395 |Email|xs:string|Email holds the email address for the contact person.
1396
Helena 4.2 1397 1.
1398 11.
Helena 2.2 1399 111. Simple Types
1400
1401 **HeaderTimeType: **Provides a union type of xs:date and xs:dateTime for the header fields in the message.
1402
1403 Union of:
1404
1405 xs:dateTime, xs:date.
1406
Helena 4.2 1407 1.
Helena 2.2 1408 11. Message Footer Namespace
1409
1410 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message/footer**
1411
Helena 4.2 1412 1.
1413 11.
Helena 2.2 1414 111. Summary
1415
1416 Referenced Namespaces:
1417
1418 |**Namespace**|**Prefix**
1419 |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
1420 |http:~/~/www.w3.org/2001/XMLSchema|xs
1421
1422 Contents:
1423
1424 1 Global Element
1425 2 Complex Types
1426 1 Simple Type
1427
Helena 4.2 1428 1.
1429 11.
Helena 2.2 1430 111. Global Elements
1431
1432 **Footer (FooterType): **Footer is used to communicate information such as error and warnings after the payload of a message.
1433
Helena 4.2 1434 1.
1435 11.
Helena 2.2 1436 111. Complex Types
1437
1438 **FooterType: **FooterType describes the structure of a message footer. The footer is used to convey any error, information, or warning messages. This is to be used when the message has payload, but also needs to communicate additional information. If an error occurs and no payload is generated, an Error message should be returned.
1439
1440 Content:
1441
1442 Message+
1443
1444 Element Documentation:
1445
1446 |**Name**|**Type**|**Documentation**
1447 |Message|FooterMessageType|Message contains a single error, information, or warning message. A code is provided along with an optional severity. The text of the message can be expressed in multiple languages.
1448
1449 **FooterMessageType: **FooterMessageType defines the structure of a message that is contained in the footer of a message. It is a status message that have a severity code of Error, Information, or Warning added to it.
1450
1451 Derivation:
1452
1453 com:StatusMessageType (restriction)
Helena 4.2 1454 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] com:CodedStatusMessageType (extension)
1455 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] FooterMessageType
Helena 2.2 1456
1457 Attributes:
1458
1459 code, severity?
1460
1461 Content:
1462
1463 com:Text+
1464
1465 Attribute Documentation:
1466
1467 |**Name**|**Type**|**Documentation**
1468 |code|xs:string|The code attribute holds an optional code identifying the underlying error that generated the message. This should be used if parallel language descriptions of the error are supplied, to distinguish which of the multiple error messages are for the same underlying error.
1469 |severity|SeverityCodeType|
1470
1471 Element Documentation:
1472
1473 |**Name**|**Type**|**Documentation**
1474 |com:Text|com:TextType|Text contains the text of the message, in parallel language values.
1475
Helena 4.2 1476 1.
1477 11.
Helena 2.2 1478 111. Simple Types
1479
1480 **SeverityCodeType:**
1481
1482 Derived by restriction of xs:string .
1483
1484 Enumerations:
1485
1486 |**Value**|**Documentation**
1487 |Error|Error indicates the status message coresponds to an error.
1488 |Warning|Warning indicates that the status message corresponds to a warning.
1489 |Information|Information indicates that the status message corresponds to an informational message.
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504