Wiki source code of Part I. Message

Version 3.18 by Helena on 2025/06/23 17:14

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