Wiki source code of Part I. Message

Version 3.2 by Helena on 2025/06/23 17:02

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
180 //MessageType// (restriction)
Helena 3.2 181 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureType
Helena 2.2 182
183 Content:
184
185 Header, Structures?, ftr:Footer?
186
187 Element Documentation:
188
189 |**Name**|**Type**|**Documentation**
190 |Header|StructureHeaderType|
191 |Structures|str:StructuresType|
192 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
193
194 **GenericDataType: **GenericDataType defines the contents of a generic data message.
195
196 Derivation:
197
198 //MessageType// (restriction)
Helena 3.2 199 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataType
Helena 2.2 200
201 Content:
202
203 Header, DataSet*, ftr:Footer?
204
205 Element Documentation:
206
207 |**Name**|**Type**|**Documentation**
208 |Header|GenericDataHeaderTyp e|
209 |DataSet|dat:DataSetType|
210 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
211
212 **GenericTimeSeriesDataType: **GenericTimeSeriesDataType defines the structure of the generic time series data message.
213
214 Derivation:
215
216 //MessageType// (restriction)
Helena 3.2 217 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataType (restriction)
218 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericTimeSeriesDataType
Helena 2.2 219
220 Content:
221
222 Header, DataSet*, ftr:Footer?
223
224 Element Documentation:
225
226 |**Name**|**Type**|**Documentation**
227 |Header|GenericTimeSeriesDat aHeaderType|
228 |DataSet|dat: TimeSeriesDataSetTyp e|
229 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
230
231 **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.
232
233 Derivation:
234
235 //MessageType// (restriction)
Helena 3.2 236 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificDataType
Helena 2.2 237
238 Content:
239
240 Header, DataSet*, ftr:Footer?
241
242 Element Documentation:
243
244 |**Name**|**Type**|**Documentation**
245 |Header|StructureSpecificDat aHeaderType|
246 |DataSet|//dsd:DataSetType//|
247 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
248
249 **StructureSpecificTimeSeriesDataType: **StructureSpecificTimeSeriesDataType defines the structure of the structure specific time series data message.
250
251 Derivation:
252
253 //MessageType// (restriction)
Helena 3.2 254 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificDataType (restriction)
255 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificTimeSeriesDataType
Helena 2.2 256
257 Content:
258
259 Header, DataSet*, ftr:Footer?
260
261 Element Documentation:
262
263 |**Name**|**Type**|**Documentation**
264 |Header|StructureSpecificTim eSeriesDataHeaderTyp e|
265 |DataSet|//dsd: TimeSeriesDataSetTyp e//|
266 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
267
268 **GenericMetadataType: **GenericMetadataType defines the contents of a generic metadata message.
269
270 Derivation:
271
272 //MessageType// (restriction)
Helena 3.2 273 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericMetadataType
Helena 2.2 274
275 Content:
276
277 Header, MetadataSet*, ftr:Footer?
278
279 Element Documentation:
280
281 |**Name**|**Type**|**Documentation**
282 |Header|GenericMetadataHeade rType|
283 |MetadataSet|rep:MetadataSetType|
284 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
285
286 **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.
287
288 Derivation:
289
290 //MessageType// (restriction)
Helena 3.2 291 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificMetadataType
Helena 2.2 292
293 Content:
294
295 Header, MetadataSet*, ftr:Footer?
296
297 Element Documentation:
298
299 |**Name**|**Type**|**Documentation**
300 |Header|StructureSpecificMet adataHeaderType|
301 |MetadataSet|//msd:MetadataSetType//|
302 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
303
304 **RegistryInterfaceType: **This is a type which describes a structure for holding all of the various dedicated registry interface message types.
305
306 Derivation:
307
308 //MessageType// (restriction)
Helena 3.2 309 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType
Helena 2.2 310
311 Content:
312
313 Header, (SubmitRegistrationsRequest | SubmitRegistrationsResponse | QueryRegistrationRequest | QueryRegistrationResponse | SubmitStructureRequest | SubmitStructureResponse | SubmitSubscriptionsRequest | SubmitSubscriptionsResponse | QuerySubscriptionRequest | QuerySubscriptionResponse | NotifyRegistryEvent)?, ftr:Footer?
314
315 Element Documentation:
316
317 |**Name**|**Type**|**Documentation**
318 |Header|BasicHeaderType|
319 |SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|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.
320 |SubmitRegistrationsR esponse|ref: SubmitRegistrationsR esponseType|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.
321 |QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|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.
322 |QueryRegistrationRes ponse|ref: QueryRegistrationRes ponseType|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.
323 |SubmitStructureReque st|ref: SubmitStructureReque stType|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.
324 |SubmitStructureRespo nse|ref: SubmitStructureRespo nseType|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.
325 |SubmitSubscriptionsR equest|ref: SubmitSubscriptionsR equestType|SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
326 |SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|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.
327 |QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
328 |QuerySubscriptionRes ponse|ref: QuerySubscriptionRes ponseType|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.
329 |NotifyRegistryEvent|ref: NotifyRegistryEventT ype|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.
330 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
331
332 **SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the structure of a registry submit registration requests document.
333
334 Derivation:
335
336 //MessageType// (restriction)
Helena 3.2 337 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
338 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitRegistrationsRequestType
Helena 2.2 339
340 Content:
341
342 Header, SubmitRegistrationsRequest
343
344 Element Documentation:
345
346 |**Name**|**Type**|**Documentation**
347 |Header|BasicHeaderType|
348 |SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|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.
349
350 **SubmitRegistrationsResponseType: **SubmitRegistrationsResponseType defines the structure of a registry submit registration response document.
351
352 Derivation:
353
354 //MessageType// (restriction)
Helena 3.2 355 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
356 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitRegistrationsResponseType
Helena 2.2 357
358 Content:
359
360 Header, SubmitRegistrationsResponse, ftr:Footer?
361
362 Element Documentation:
363
364 |**Name**|**Type**|**Documentation**
365 |Header|BasicHeaderType|
366 |SubmitRegistrationsR esponse|ref: SubmitRegistrationsR esponseType|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.
367 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
368
369 **QueryRegistrationRequestType: **QueryRegistrationRequestType defines the structure of a registry query registration request document.
370
371 Derivation:
372
373 //MessageType// (restriction)
Helena 3.2 374 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
375 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QueryRegistrationRequestType
Helena 2.2 376
377 Content:
378
379 Header, QueryRegistrationRequest
380
381 Element Documentation:
382
383 |**Name**|**Type**|**Documentation**
384 |Header|BasicHeaderType|
385 |QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|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.
386
387 **QueryRegistrationResponseType: **SubmitRegistrationRequestType defines the structure of a registry submit registration response document.
388
389 Derivation:
390
391 //MessageType// (restriction)
Helena 3.2 392 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
393 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QueryRegistrationResponseType
Helena 2.2 394
395 Content:
396
397 Header, QueryRegistrationResponse, ftr:Footer?
398
399 Element Documentation:
400
401 |**Name**|**Type**|**Documentation**
402 |Header|BasicHeaderType|
403 |QueryRegistrationRes ponse|ref: QueryRegistrationRes ponseType|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.
404 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
405
406 **SubmitStructureRequestType: **SubmitStructureRequestType defines the structure of a registry submit structure request document.
407
408 Derivation:
409
410 //MessageType// (restriction)
Helena 3.2 411 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
412 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitStructureRequestType
Helena 2.2 413
414 Content:
415
416 Header, SubmitStructureRequest
417
418 Element Documentation:
419
420 |**Name**|**Type**|**Documentation**
421 |Header|BasicHeaderType|
422 |SubmitStructureReque st|ref: SubmitStructureReque stType|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.
423
424 **SubmitStructureResponseType: **SubmitStructureResponseType defines the structure of a registry submit registration response document.
425
426 Derivation:
427
428 //MessageType// (restriction)
Helena 3.2 429 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
430 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitStructureResponseType
Helena 2.2 431
432 Content:
433
434 Header, SubmitStructureResponse, ftr:Footer?
435
436 Element Documentation:
437
438 |**Name**|**Type**|**Documentation**
439 |Header|BasicHeaderType|
440 |SubmitStructureRespo nse|ref: SubmitStructureRespo nseType|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.
441 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
442
443 **SubmitSubscriptionsRequestType: **SubmitSubscriptionsRequestType defines the structure of a registry submit subscription request document.
444
445 Derivation:
446
447 //MessageType// (restriction)
Helena 3.2 448 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
449 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitSubscriptionsRequestType
Helena 2.2 450
451 Content:
452
453 Header, SubmitSubscriptionsRequest
454
455 Element Documentation:
456
457 |**Name**|**Type**|**Documentation**
458 |Header|BasicHeaderType|
459 |SubmitSubscriptionsR equest|ref: SubmitSubscriptionsR equestType|SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
460
461 **SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType defines the structure of a registry submit subscription response document.
462
463 Derivation:
464
465 //MessageType// (restriction)
Helena 3.2 466 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
467 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitSubscriptionsResponseType
Helena 2.2 468
469 Content:
470
471 Header, SubmitSubscriptionsResponse, ftr:Footer?
472
473 Element Documentation:
474
475 |**Name**|**Type**|**Documentation**
476 |Header|BasicHeaderType|
477 |SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|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.
478 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
479
480 **QuerySubscriptionRequestType: **QuerySubscriptionRequestType defines the structure of a registry query subscription request document.
481
482 Derivation:
483
484 //MessageType// (restriction)
Helena 3.2 485 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
486 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QuerySubscriptionRequestType
Helena 2.2 487
488 Content:
489
490 Header, QuerySubscriptionRequest
491
492 Element Documentation:
493
494 |**Name**|**Type**|**Documentation**
495 |Header|BasicHeaderType|
496 |QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
497
498 **QuerySubscriptionResponseType: **QuerySubscriptionResponseType defines the structure of a registry query subscription response document.
499
500 Derivation:
501
502 //MessageType// (restriction)
Helena 3.2 503 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
504 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QuerySubscriptionResponseType
Helena 2.2 505
506 Content:
507
508 Header, QuerySubscriptionResponse, ftr:Footer?
509
510 Element Documentation:
511
512 |**Name**|**Type**|**Documentation**
513 |Header|BasicHeaderType|
514 |QuerySubscriptionRes ponse|ref: QuerySubscriptionRes ponseType|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.
515 |ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
516
517 **NotifyRegistryEventType: **NotifyRegistryEventType defines the structure of a registry notification document.
518
519 Derivation:
520
521 //MessageType// (restriction)
522 RegistryInterfaceType (restriction)
523 NotifyRegistryEventType
524
525 Content:
526
527 Header, NotifyRegistryEvent
528
529 Element Documentation:
530
531 |**Name**|**Type**|**Documentation**
532 |Header|BasicHeaderType|
533 |NotifyRegistryEvent|ref: NotifyRegistryEventT ype|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.
534
535 **DataQueryType: **DataQueryType defines the structure of a data query message.
536
537 Derivation:
538
539 //MessageType// (restriction)
540 DataQueryType
541
542 Content:
543
544 Header, Query
545
546 Element Documentation:
547
548 |**Name**|**Type**|**Documentation**
549 |Header|BasicHeaderType|
550 |Query|qry:DataQueryType|
551
552 **GenericDataQueryType: **DataQueryType defines the structure of a generic data query message.
553
554 Derivation:
555
556 //MessageType// (restriction)
557 DataQueryType (restriction)
558 GenericDataQueryType
559
560 Content:
561
562 Header, Query
563
564 Element Documentation:
565
566 |**Name**|**Type**|**Documentation**
567 |Header|BasicHeaderType|
568 |Query|qry: GenericDataQueryType|
569
570 **GenericTimeSeriesDataQueryType: **GenericTimeSeriesDataQueryType defines the structure of a time series generic data query message.
571
572 Derivation:
573
574 //MessageType// (restriction)
575 DataQueryType (restriction)
576 GenericDataQueryType (restriction)
577 GenericTimeSeriesDataQueryType
578
579 Content:
580
581 Header, Query
582
583 Element Documentation:
584
585 |**Name**|**Type**|**Documentation**
586 |Header|BasicHeaderType|
587 |Query|qry: GenericTimeSeriesDat aQueryType|
588
589 **StructureSpecificTimeSeriesDataQueryType: **StructureSpecificTimeSeriesDataQueryType defines the structure of a time series generic data query message.
590
591 Derivation:
592
593 //MessageType// (restriction)
594 DataQueryType (restriction)
595 StructureSpecificTimeSeriesDataQueryType
596
597 Content:
598
599 Header, Query
600
601 Element Documentation:
602
603 |**Name**|**Type**|**Documentation**
604 |Header|BasicHeaderType|
605 |Query|qry: TimeSeriesDataQueryT ype|
606
607 **MetadataQueryType: **MetadataQueryType defines the structure of a reference metadata query message.
608
609 Derivation:
610
611 //MessageType// (restriction)
612 MetadataQueryType
613
614 Content:
615
616 Header, Query
617
618 Element Documentation:
619
620 |**Name**|**Type**|**Documentation**
621 |Header|BasicHeaderType|
622 |Query|qry: MetadataQueryType|
623
624 **DataSchemaQueryType: **DataSchemaQueryType defines the structure of a data schema query message.
625
626 Derivation:
627
628 //MessageType// (restriction)
629 DataSchemaQueryType
630
631 Content:
632
633 Header, Query
634
635 Element Documentation:
636
637 |**Name**|**Type**|**Documentation**
638 |Header|BasicHeaderType|
639 |Query|qry: DataSchemaQueryType|
640
641 **MetadataSchemaQueryType: **MetadataSchemaQueryType defines the structure of a metadata schema query message.
642
643 Derivation:
644
645 //MessageType// (restriction)
646 MetadataSchemaQueryType
647
648 Content:
649
650 Header, Query
651
652 Element Documentation:
653
654 |**Name**|**Type**|**Documentation**
655 |Header|BasicHeaderType|
656 |Query|qry: MetadataSchemaQueryT ype|
657
658 **StructuresQueryType: **StructuresQueryType defines the structure of a structures query message.
659
660 Derivation:
661
662 //MessageType// (restriction)
663 StructuresQueryType
664
665 Content:
666
667 Header, Query
668
669 Element Documentation:
670
671 |**Name**|**Type**|**Documentation**
672 |Header|BasicHeaderType|
673 |Query|qry: StructuresQueryType|
674
675 **DataflowQueryType: **DataflowQueryType defines the structure of a dataflow query message.
676
677 Derivation:
678
679 //MessageType// (restriction)
680 DataflowQueryType
681
682 Content:
683
684 Header, Query
685
686 Element Documentation:
687
688 |**Name**|**Type**|**Documentation**
689 |Header|BasicHeaderType|
690 |Query|qry: DataflowQueryType|
691
692 **MetadataflowQueryType: **MetadataflowQueryType defines the structure of a metadata flow query message.
693
694 Derivation:
695
696 //MessageType// (restriction)
697 MetadataflowQueryType
698
699 Content:
700
701 Header, Query
702
703 Element Documentation:
704
705 |**Name**|**Type**|**Documentation**
706 |Header|BasicHeaderType|
707 |Query|qry: MetadataflowQueryTyp e|
708
709 **DataStructureQueryType: **KeyFamilyQueryType defines the structure of a data structure query message.
710
711 Derivation:
712
713 //MessageType// (restriction)
714 DataStructureQueryType
715
716 Content:
717
718 Header, Query
719
720 Element Documentation:
721
722 |**Name**|**Type**|**Documentation**
723 |Header|BasicHeaderType|
724 |Query|qry: DataStructureQueryTy pe|
725
726 **MetadataStructureQueryType: **MetadataStructureQueryType defines the structure of a metadata structure query message.
727
728 Derivation:
729
730 //MessageType// (restriction)
731 MetadataStructureQueryType
732
733 Content:
734
735 Header, Query
736
737 Element Documentation:
738
739 |**Name**|**Type**|**Documentation**
740 |Header|BasicHeaderType|
741 |Query|qry: MetadataStructureQue ryType|
742
743 **CategorySchemeQueryType: **CategorySchemeQueryType defines the structure of a category scheme query message.
744
745 Derivation:
746
747 //MessageType// (restriction)
748 CategorySchemeQueryType
749
750 Content:
751
752 Header, Query
753
754 Element Documentation:
755
756 |**Name**|**Type**|**Documentation**
757 |Header|BasicHeaderType|
758 |Query|qry: CategorySchemeQueryT ype|
759
760 **ConceptSchemeQueryType: **ConceptSchemeQueryType defines the structure of a concept scheme query message.
761
762 Derivation:
763
764 //MessageType// (restriction)
765 ConceptSchemeQueryType
766
767 Content:
768
769 Header, Query
770
771 Element Documentation:
772
773 |**Name**|**Type**|**Documentation**
774 |Header|BasicHeaderType|
775 |Query|qry: ConceptSchemeQueryTy pe|
776
777 **CodelistQueryType: **CodelistQueryType defines the structure of a codelist query message.
778
779 Derivation:
780
781 //MessageType// (restriction)
782 CodelistQueryType
783
784 Content:
785
786 Header, Query
787
788 Element Documentation:
789
790 |**Name**|**Type**|**Documentation**
791 |Header|BasicHeaderType|
792 |Query|qry: CodelistQueryType|
793
794 **HierarchicalCodelistQueryType: **HierarchicalCodelistQueryType defines the structure of a hierarchical codelist query message.
795
796 Derivation:
797
798 //MessageType// (restriction)
799 HierarchicalCodelistQueryType
800
801 Content:
802
803 Header, Query
804
805 Element Documentation:
806
807 |**Name**|**Type**|**Documentation**
808 |Header|BasicHeaderType|
809 |Query|qry: HierarchicalCodelist QueryType|
810
811 **OrganisationSchemeQueryType: **OrganisationSchemeQueryType defines the structure of an organisation scheme query message.
812
813 Derivation:
814
815 //MessageType// (restriction)
816 OrganisationSchemeQueryType
817
818 Content:
819
820 Header, Query
821
822 Element Documentation:
823
824 |**Name**|**Type**|**Documentation**
825 |Header|BasicHeaderType|
826 |Query|qry: OrganisationSchemeQu eryType|
827
828 **ReportingTaxonomyQueryType: **ReportingTaxonomyQueryType defines the structure of a reporting taxonomy query message.
829
830 Derivation:
831
832 //MessageType// (restriction)
833 ReportingTaxonomyQueryType
834
835 Content:
836
837 Header, Query
838
839 Element Documentation:
840
841 |**Name**|**Type**|**Documentation**
842 |Header|BasicHeaderType|
843 |Query|qry: ReportingTaxonomyQue ryType|
844
845 **StructureSetQueryType: **StructureSetQueryType defines the structure of a structure set query message.
846
847 Derivation:
848
849 //MessageType// (restriction)
850 StructureSetQueryType
851
852 Content:
853
854 Header, Query
855
856 Element Documentation:
857
858 |**Name**|**Type**|**Documentation**
859 |Header|BasicHeaderType|
860 |Query|qry: StructureSetQueryTyp e|
861
862 **ProcessQueryType: **CategorizationQueryType defines the structure of a categorization query message.
863
864 Derivation:
865
866 //MessageType// (restriction)
867 ProcessQueryType
868
869 Content:
870
871 Header, Query
872
873 Element Documentation:
874
875 |**Name**|**Type**|**Documentation**
876 |Header|BasicHeaderType|
877 |Query|qry:ProcessQueryType|
878
879 **CategorisationQueryType: **CategorisationQueryType defines the structure of a categorisation query message.
880
881 Derivation:
882
883 //MessageType// (restriction)
884 CategorisationQueryType
885
886 Content:
887
888 Header, Query
889
890 Element Documentation:
891
892 |**Name**|**Type**|**Documentation**
893 |Header|BasicHeaderType|
894 |Query|qry: CategorisationQueryT ype|
895
896 **ProvisionAgreementQueryType: **ProvisionAgreementQueryType defines the structure of a provision agreement query message.
897
898 Derivation:
899
900 //MessageType// (restriction)
901 ProvisionAgreementQueryType
902
903 Content:
904
905 Header, Query
906
907 Element Documentation:
908
909 |**Name**|**Type**|**Documentation**
910 |Header|BasicHeaderType|
911 |Query|qry: ProvisionAgreementQu eryType|
912
913 **ConstraintQueryType: **ConstraintQueryType defines the structure of a constraint query message.
914
915 Derivation:
916
917 //MessageType// (restriction)
918 ConstraintQueryType
919
920 Content:
921
922 Header, Query
923
924 Element Documentation:
925
926 |**Name**|**Type**|**Documentation**
927 |Header|BasicHeaderType|
928 |Query|qry: ConstraintQueryType|
929
930 **TransformationSchemeQueryType: **TransformationSchemeQueryType defines the structure of a transformation scheme query message.
931
932 Derivation:
933
934 //MessageType// (restriction)
935 TransformationSchemeQueryType
936
937 Content:
938
939 Header, Query
940
941 Element Documentation:
942
943 |**Name**|**Type**|**Documentation**
944 |Header|BasicHeaderType|
945 |Query|qry: TransformationScheme QueryType|
946
947 **VtlMappingSchemeQueryType: **VtlMappingSchemeQueryType defines the structure of a VTL mappings scheme query message.
948
949 Derivation:
950
951 //MessageType// (restriction)
952 VtlMappingSchemeQueryType
953
954 Content:
955
956 Header, Query
957
958 Element Documentation:
959
960 |**Name**|**Type**|**Documentation**
961 |Header|BasicHeaderType|
962 |Query|qry: VtlMappingSchemeQuer yType|
963
964 **NamePersonalisationSchemeQueryType: **NamePersonalisationSchemeQueryType defines the structure of a name personalisation scheme query message.
965
966 Derivation:
967
968 //MessageType// (restriction)
969 NamePersonalisationSchemeQueryType
970
971 Content:
972
973 Header, Query
974
975 Element Documentation:
976
977 |**Name**|**Type**|**Documentation**
978 |Header|BasicHeaderType|
979 |Query|qry: NamePersonalisationS chemeQueryType|
980
981 **RulesetSchemeQueryType: **RulesetSchemeQueryType defines the structure of a ruleset scheme query message.
982
983 Derivation:
984
985 //MessageType// (restriction)
986 RulesetSchemeQueryType
987
988 Content:
989
990 Header, Query
991
992 Element Documentation:
993
994 |**Name**|**Type**|**Documentation**
995 |Header|BasicHeaderType|
996 |Query|qry: RulesetSchemeQueryTy pe|
997
998 **UserDefinedOperatorSchemeQueryType: **UserDefinedOperatorSchemeQueryType defines the structure of a user defined operator scheme query message.
999
1000 Derivation:
1001
1002 //MessageType// (restriction)
1003 UserDefinedOperatorSchemeQueryType
1004
1005 Content:
1006
1007 Header, Query
1008
1009 Element Documentation:
1010
1011 |**Name**|**Type**|**Documentation**
1012 |Header|BasicHeaderType|
1013 |Query|qry: UserDefinedOperatorS chemeQueryType|
1014
1015 **CustomTypeSchemeQueryType: **CustomTypeSchemeQueryType defines the structure of a custom type scheme query message.
1016
1017 Derivation:
1018
1019 //MessageType// (restriction)
Helena 3.2 1020 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] CustomTypeSchemeQueryType
Helena 2.2 1021
1022 Content:
1023
1024 Header, Query
1025
1026 Element Documentation:
1027
1028 |**Name**|**Type**|**Documentation**
1029 |Header|BasicHeaderType|
1030 |Query|qry: CustomTypeSchemeQuer yType|
1031
1032 **ErrorType: **ErrorType describes the structure of an error response.
1033
1034 Content:
1035
1036 ErrorMessage+
1037
1038 Element Documentation:
1039
1040 |**Name**|**Type**|**Documentation**
1041 |ErrorMessage|com: CodedStatusMessageTy pe|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.
1042
1043 **//BaseHeaderType//: **BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this
1044
1045 Content:
1046
1047 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure*, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1048
1049 Element Documentation:
1050
1051 |**Name**|**Type**|**Documentation**
1052 |ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1053 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1054 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1055 |Sender|SenderType|Sender is information about the party that is transmitting the message.
1056 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1057 |com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1058 |Structure|//com: PayloadStructureType//|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.
1059 |DataProvider|com: DataProviderReferenc eType|DataProvider identifies the provider of the data for a data/reference metadata message.
1060 |DataSetAction|com:ActionType|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).
1061 |DataSetID|com:IDType|DataSetID provides an identifier for a contained data set.
1062 |Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.
1063 |ReportingBegin|com: ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).
1064 |ReportingEnd|com: ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).
1065 |EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.
1066 |Source|com:TextType|Source provides human-readable information about the source of the data.
1067
1068 **StructureHeaderType: **StructureHeaderType defines the structure for structural metadata messages.
1069
1070 Derivation:
1071
1072 //BaseHeaderType// (restriction)
1073 StructureHeaderType
1074
1075 Content:
1076
1077 ID, Test, Prepared, Sender, Receiver*, com:Name*, Source*
1078
1079 Element Documentation:
1080
1081 |**Name**|**Type**|**Documentation**
1082 |ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1083 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1084 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1085 |Sender|SenderType|Sender is information about the party that is transmitting the message.
1086 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1087 |com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1088 |Source|com:TextType|Source provides human-readable information about the source of the data.
1089
1090 **GenericDataHeaderType: **GenericDataHeaderType defines the header structure for a generic data message.
1091
1092 Derivation:
1093
1094 //BaseHeaderType// (restriction)
Helena 3.2 1095 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericDataHeaderType
Helena 2.2 1096
1097 Content:
1098
1099 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1100
1101 Element Documentation:
1102
1103 |**Name**|**Type**|**Documentation**
1104 |ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1105 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1106 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1107 |Sender|SenderType|Sender is information about the party that is transmitting the message.
1108 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1109 |com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1110 |Structure|com: GenericDataStructure Type|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.
1111 |DataProvider|com: DataProviderReferenc eType|DataProvider identifies the provider of the data for a data/reference metadata message.
1112 |DataSetAction|com:ActionType|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).
1113 |DataSetID|com:IDType|DataSetID provides an identifier for a contained data set.
1114 |Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.
1115 |ReportingBegin|com: ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).
1116 |ReportingEnd|com: ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).
1117 |EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.
1118 |Source|com:TextType|Source provides human-readable information about the source of the data.
1119
1120 **GenericTimeSeriesDataHeaderType: **GenericTimeSeriesDataHeaderType defines the header structure for a time series only generic data message.
1121
1122 Derivation:
1123
1124 //BaseHeaderType// (restriction)
1125 GenericDataHeaderType (restriction)
1126 GenericTimeSeriesDataHeaderType
1127
1128 Content:
1129
1130 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1131
1132 Element Documentation:
1133
1134 |**Name**|**Type**|**Documentation**
1135 |ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1136 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1137 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1138 |Sender|SenderType|Sender is information about the party that is transmitting the message.
1139 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1140 |com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1141 |Structure|com: GenericTimeSeriesDat aStructureType|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.
1142 |DataProvider|com: DataProviderReferenc eType|DataProvider identifies the provider of the data for a data/reference metadata message.
1143 |DataSetAction|com:ActionType|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).
1144 |DataSetID|com:IDType|DataSetID provides an identifier for a contained data set.
1145 |Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.
1146 |ReportingBegin|com: ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).
1147 |ReportingEnd|com: ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).
1148 |EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.
1149 |Source|com:TextType|Source provides human-readable information about the source of the data.
1150
1151 **StructureSpecificDataHeaderType: **StructureSpecificDataHeaderType defines the header structure for a structure specific data message.
1152
1153 Derivation:
1154
1155 //BaseHeaderType// (restriction)
1156 StructureSpecificDataHeaderType
1157
1158 Content:
1159
1160 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1161
1162 Element Documentation:
1163
1164 |**Name**|**Type**|**Documentation**
1165 |ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1166 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1167 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1168 |Sender|SenderType|Sender is information about the party that is transmitting the message.
1169 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1170 |com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1171 |Structure|com: StructureSpecificDat aStructureType|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.
1172 |DataProvider|com: DataProviderReferenc eType|DataProvider identifies the provider of the data for a data/reference metadata message.
1173 |DataSetAction|com:ActionType|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).
1174 |DataSetID|com:IDType|DataSetID provides an identifier for a contained data set.
1175 |Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.
1176 |ReportingBegin|com: ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).
1177 |ReportingEnd|com: ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).
1178 |EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.
1179 |Source|com:TextType|Source provides human-readable information about the source of the data.
1180
1181 **StructureSpecificTimeSeriesDataHeaderType: **StructureSpecificTimeSeriesDataHeaderType defines the header structure for a time series only structure specific data message.
1182
1183 Derivation:
1184
1185 //BaseHeaderType// (restriction)
1186 StructureSpecificDataHeaderType (restriction)
1187 StructureSpecificTimeSeriesDataHeaderType
1188
1189 Content:
1190
1191 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source*
1192
1193 Element Documentation:
1194
1195 |**Name**|**Type**|**Documentation**
1196 |ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1197 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1198 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1199 |Sender|SenderType|Sender is information about the party that is transmitting the message.
1200 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1201 |com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1202 |Structure|com: StructureSpecificDat aTimeSeriesStructure Type|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.
1203 |DataProvider|com: DataProviderReferenc eType|DataProvider identifies the provider of the data for a data/reference metadata message.
1204 |DataSetAction|com:ActionType|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).
1205 |DataSetID|com:IDType|DataSetID provides an identifier for a contained data set.
1206 |Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.
1207 |ReportingBegin|com: ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).
1208 |ReportingEnd|com: ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).
1209 |EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.
1210 |Source|com:TextType|Source provides human-readable information about the source of the data.
1211
1212 **GenericMetadataHeaderType: **GenericMetadataHeaderType defines the header format for generic reference metadata.
1213
1214 Derivation:
1215
1216 //BaseHeaderType// (restriction)
1217 GenericMetadataHeaderType
1218
1219 Content:
1220
1221 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, Source*
1222
1223 Element Documentation:
1224
1225 |**Name**|**Type**|**Documentation**
1226 |ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1227 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1228 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1229 |Sender|SenderType|Sender is information about the party that is transmitting the message.
1230 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1231 |com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1232 |Structure|com: GenericMetadataStruc tureType|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.
1233 |DataProvider|com: DataProviderReferenc eType|DataProvider identifies the provider of the data for a data/reference metadata message.
1234 |DataSetAction|com:ActionType|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).
1235 |DataSetID|com:IDType|DataSetID provides an identifier for a contained data set.
1236 |Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.
1237 |Source|com:TextType|Source provides human-readable information about the source of the data.
1238
1239 **StructureSpecificMetadataHeaderType: **StructureSpecificMetadataHeaderType defines the header format for metadata structure definition specific reference metadata messages.
1240
1241 Derivation:
1242
1243 //BaseHeaderType// (restriction)
Helena 3.2 1244 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificMetadataHeaderType
Helena 2.2 1245
1246 Content:
1247
1248 ID, Test, Prepared, Sender, Receiver*, com:Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, Source*
1249
1250 Element Documentation:
1251
1252 |**Name**|**Type**|**Documentation**
1253 |ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1254 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1255 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1256 |Sender|SenderType|Sender is information about the party that is transmitting the message.
1257 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1258 |com:Name|com:TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.
1259 |Structure|com: StructureSpecificMet adataStructureType|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.
1260 |DataProvider|com: DataProviderReferenc eType|DataProvider identifies the provider of the data for a data/reference metadata message.
1261 |DataSetAction|com:ActionType|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).
1262 |DataSetID|com:IDType|DataSetID provides an identifier for a contained data set.
1263 |Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.
1264 |Source|com:TextType|Source provides human-readable information about the source of the data.
1265
1266 **BasicHeaderType: **BasicHeaderType defines the most basic header information used in simple message exchanges.
1267
1268 Derivation:
1269
1270 //BaseHeaderType// (restriction)
Helena 3.2 1271 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] BasicHeaderType
Helena 2.2 1272
1273 Content:
1274
1275 ID, Test, Prepared, Sender, Receiver
1276
1277 Element Documentation:
1278
1279 |**Name**|**Type**|**Documentation**
1280 |ID|com:IDType|ID identifies an identification for the message, assigned by the sender.
1281 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.
1282 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.
1283 |Sender|SenderType|Sender is information about the party that is transmitting the message.
1284 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.
1285
1286 **PartyType: **PartyType defines the information which is sent about various parties such as senders and receivers of messages.
1287
1288 Attributes:
1289
1290 id
1291
1292 Content:
1293
1294 com:Name*, Contact*
1295
1296 Attribute Documentation:
1297
1298 |**Name**|**Type**|**Documentation**
1299 |id|com:IDType|The id attribute holds the identification of the party.
1300
1301 Element Documentation:
1302
1303 |**Name**|**Type**|**Documentation**
1304 |com:Name|com:TextType|Name is a human-readable name of the party.
1305 |Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.
1306
1307 **SenderType: **SenderType extends the basic party structure to add an optional time zone declaration.
1308
1309 Derivation:
1310
1311 PartyType (extension)
Helena 3.2 1312 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SenderType
Helena 2.2 1313
1314 Attributes:
1315
1316 id
1317
1318 Content:
1319
1320 com:Name*, Contact*, Timezone?
1321
1322 Attribute Documentation:
1323
1324 |**Name**|**Type**|**Documentation**
1325 |id|com:IDType|The id attribute holds the identification of the party.
1326
1327 Element Documentation:
1328
1329 |**Name**|**Type**|**Documentation**
1330 |com:Name|com:TextType|Name is a human-readable name of the party.
1331 |Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.
1332 |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".
1333
1334 **ContactType: **ContactType provides defines the contact information about a party.
1335
1336 Content:
1337
1338 com:Name*, Department*, Role*, (Telephone | Fax | X400 | URI | Email)*
1339
1340 Element Documentation:
1341
1342 |**Name**|**Type**|**Documentation**
1343 |com:Name|com:TextType|Name contains a human-readable name for the contact.
1344 |Department|com:TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.
1345 |Role|com:TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.
1346 |Telephone|xs:string|Telephone holds the telephone number for the contact person.
1347 |Fax|xs:string|Fax holds the fax number for the contact person.
1348 |X400|xs:string|X400 holds the X.400 address for the contact person.
1349 |URI|xs:anyURI|URI holds an information URL for the contact person.
1350 |Email|xs:string|Email holds the email address for the contact person.
1351
Helena 3.2 1352 1.
1353 11.
Helena 2.2 1354 111. Simple Types
1355
1356 **HeaderTimeType: **Provides a union type of xs:date and xs:dateTime for the header fields in the message.
1357
1358 Union of:
1359
1360 xs:dateTime, xs:date.
1361
Helena 3.2 1362 1.
Helena 2.2 1363 11. Message Footer Namespace
1364
1365 **http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message/footer**
1366
Helena 3.2 1367 1.
1368 11.
Helena 2.2 1369 111. Summary
1370
1371 Referenced Namespaces:
1372
1373 |**Namespace**|**Prefix**
1374 |http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|com
1375 |http:~/~/www.w3.org/2001/XMLSchema|xs
1376
1377 Contents:
1378
1379 1 Global Element
1380 2 Complex Types
1381 1 Simple Type
1382
Helena 3.2 1383 1.
1384 11.
Helena 2.2 1385 111. Global Elements
1386
1387 **Footer (FooterType): **Footer is used to communicate information such as error and warnings after the payload of a message.
1388
Helena 3.2 1389 1.
1390 11.
Helena 2.2 1391 111. Complex Types
1392
1393 **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.
1394
1395 Content:
1396
1397 Message+
1398
1399 Element Documentation:
1400
1401 |**Name**|**Type**|**Documentation**
1402 |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.
1403
1404 **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.
1405
1406 Derivation:
1407
1408 com:StatusMessageType (restriction)
Helena 3.2 1409 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] com:CodedStatusMessageType (extension)
1410 [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] FooterMessageType
Helena 2.2 1411
1412 Attributes:
1413
1414 code, severity?
1415
1416 Content:
1417
1418 com:Text+
1419
1420 Attribute Documentation:
1421
1422 |**Name**|**Type**|**Documentation**
1423 |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.
1424 |severity|SeverityCodeType|
1425
1426 Element Documentation:
1427
1428 |**Name**|**Type**|**Documentation**
1429 |com:Text|com:TextType|Text contains the text of the message, in parallel language values.
1430
Helena 3.2 1431 1.
1432 11.
Helena 2.2 1433 111. Simple Types
1434
1435 **SeverityCodeType:**
1436
1437 Derived by restriction of xs:string .
1438
1439 Enumerations:
1440
1441 |**Value**|**Documentation**
1442 |Error|Error indicates the status message coresponds to an error.
1443 |Warning|Warning indicates that the status message corresponds to a warning.
1444 |Information|Information indicates that the status message corresponds to an informational message.
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459