Wiki source code of Part I. Message

Version 3.11 by Helena on 2025/06/23 17:08

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