Wiki source code of Part I. Message

Version 3.10 by Helena on 2025/06/23 17:07

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