Wiki source code of Part I. Message

Version 3.4 by Helena on 2025/06/23 17:05

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