Skip to Content

Wiki source code of Part I. Message

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