Wiki source code of Part I. Message

Version 3.16 by Helena on 2025/06/23 17:13

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