Wiki source code of Part I. Message

Version 3.3 by Helena on 2025/06/23 17:03

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