Wiki source code of Part I. Message

Version 3.5 by Helena on 2025/07/02 11:00

Hide last authors
Helena 2.2 1 {{box title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
5 = 1 Introduction =
6
Helena 3.2 7 At the core of the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] 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>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]].
Helena 2.2 8
Helena 3.2 9 There are two namespaces associated with the messages. The main namespace schema which defines every message in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] is http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message. Associated with this is another sub-namespace, http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer. This namespace defines footer (% style="color:#e74c3c" %)level(%%) information that is available in messages which might require non-standard payload information to be transmitted.
Helena 2.2 10
Helena 3.2 11 In general, every message in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] follows common format of:
Helena 2.2 12
13 * Header
14 * Payload (0..n)
15 * Footer (0..1)
16
17 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.
18
19 = 2 Schema Documentation =
20
21 == 2.1 Message Namespace ==
22
23 http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message
24
25 === 2.1.1 Summary ===
26
27 Referenced Namespaces:
28
Helena 3.3 29 (% style="width:973.294px" %)
30 |(% style="width:610px" %)**Namespace**|(% style="width:360px" %)**Prefix**
31 |(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|(% style="width:360px" %)common
32 |(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|(% style="width:360px" %)dsd
33 |(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer|(% style="width:360px" %)footer
34 |(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/metadata/generic|(% style="width:360px" %)metadata
35 |(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/registry|(% style="width:360px" %)registry
36 |(% style="width:610px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/structure|(% style="width:360px" %)structure
37 |(% style="width:610px" %)http://www.w3.org/2001/XMLSchema|(% style="width:360px" %)xs
Helena 2.2 38
39 Contents:
40 7 Global Elements
41 16 Complex Types
42 1 Simple Type
43
44 === 2.1.2 Global Elements ===
45
Helena 3.2 46 **Structure (StructureType):** Structure is a message that contains [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]]. It may contain any of the following; categorisations, [[category schemes>>doc:sdmx:Glossary.Category scheme.WebHome]], [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], (% style="color:#e74c3c" %)concepts(%%) ([[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]]), data and metadata (% style="color:#e74c3c" %)constraints(%%), [[data flows>>doc:sdmx:Glossary.Dataflow.WebHome]], [[hierarchical code lists>>doc:sdmx:Glossary.Hierarchical code list.WebHome]], [[metadata flows>>doc:sdmx:Glossary.Metadataflow.WebHome]], [[metadata structure definitions>>doc:sdmx:Glossary.Metadata structure definition.WebHome]], organisation schemes, processes, [[reporting taxonomies>>doc:sdmx:Glossary.Reporting taxonomy.WebHome]], structure (% style="color:#e74c3c" %)maps(%%), [[representation>>doc:sdmx:Glossary.Representation.WebHome]] (% style="color:#e74c3c" %)maps(%%), .
Helena 2.2 47
Helena 3.2 48 **StructureSpecificData (StructureSpecificDataType):** StructureSpecificData is used to convey data structure specific according to [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]]. The payload of this message (i.e. the [[data sets>>doc:sdmx:Glossary.Data set.WebHome]]) will be based on XML schemas which are specific to the [[data structure definition>>doc:sdmx:Glossary.Data structure definition.WebHome]] and the orientation (i.e. the observation [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]]) of the data.
Helena 2.2 49
50 **GenericMetadata (GenericMetadataType):** GenericMetadata contains reported metadata in a format which supports any metadata structure definition.
51
Helena 3.2 52 **RegistryInterface (RegistryInterfaceType):** RegistryInterface is used to conduct all interactions with the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Services.
Helena 2.2 53
Helena 3.2 54 **SubmitStructureRequest (SubmitStructureRequestType):** SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, (% style="color:#e74c3c" %)concepts(%%) and [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], etc.) to be submitted may be communicated in-line or be supplied in a referenced [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure messages external to the registry. A response will indicate status and contain any relevant error information.
Helena 2.2 55
56 **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.
57
58 **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.
59
60 === 2.1.3 Complex Types ===
61
62 ***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.
63
64 Content:
65
66 Header, {any element with namespace of http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message}*, Footer?
67
68 Element Documentation:
69
Helena 3.3 70 (% style="width:1007.29px" %)
71 |**Name**|(% style="width:192px" %)**Type**|(% style="width:662px" %)**Documentation**
72 |Header|(% style="width:192px" %)*BaseHeaderType*|(% style="width:662px" %)
73 |Footer|(% style="width:192px" %)FooterType|(% style="width:662px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 74
75 **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.
76
77 Derivation:
78
79 MessageType (restriction)
Helena 3.1 80 StructureType
Helena 2.2 81
82 Content:
83 Header, Structures?, Footer?
84
85 Element Documentation:
86
Helena 3.3 87 (% style="width:1007.29px" %)
88 |**Name**|(% style="width:228px" %)**Type**|(% style="width:589px" %)**Documentation**
89 |Header|(% style="width:228px" %)StructureHeaderType|(% style="width:589px" %)
90 |Structures|(% style="width:228px" %)StructuresType|(% style="width:589px" %)
91 |Footer|(% style="width:228px" %)FooterType|(% style="width:589px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 92
93 **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.
94
95 Derivation:
96
Helena 3.1 97 MessageType (restriction)
98 StructureSpecificDataType
Helena 2.2 99
100 Content:
101 Header, DataSet*, Footer?
102
103 Element Documentation:
104
Helena 3.4 105 (% style="width:1005.29px" %)
106 |**Name**|(% style="width:269px" %)**Type**|(% style="width:585px" %)**Documentation**
107 |Header|(% style="width:269px" %)StructureSpecificDat aHeaderType|(% style="width:585px" %)
108 |DataSet|(% style="width:269px" %)*DataSetType*|(% style="width:585px" %)
109 |Footer|(% style="width:269px" %)FooterType|(% style="width:585px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 110
111 **GenericMetadataType:** GenericMetadataType defines the contents of a generic metadata message.
112
113 Derivation:
114
115 MessageType (restriction)
Helena 3.1 116 GenericMetadataType
Helena 2.2 117
118 Content:
119 Header, MetadataSet*, Footer?
120
121 Element Documentation:
122
Helena 3.4 123 (% style="width:1012.29px" %)
124 |**Name**|(% style="width:309px" %)**Type**|(% style="width:593px" %)**Documentation**
125 |Header|(% style="width:309px" %)GenericMetadataHeaderType|(% style="width:593px" %)
126 |MetadataSet|(% style="width:309px" %)MetadataSetType|(% style="width:593px" %)
127 |Footer|(% style="width:309px" %)FooterType|(% style="width:593px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 128
129 **RegistryInterfaceType:** This is a type which describes a structure for holding all of the various dedicated registry interface message types.
130
131 Derivation:
132
133 MessageType (restriction)
Helena 3.1 134 RegistryInterfaceType
Helena 2.2 135
136 Content:
137 Header, (SubmitRegistrationsRequest|SubmitRegistrationsResponse|QueryRegistrationRequest|QueryRegistrationResponse|SubmitStructureRequest|SubmitStructureResponse|SubmitSubscriptionsRequest|SubmitSubscriptionsResponse|QuerySubscriptionRequest|QuerySubscriptionResponse|NotifyRegistryEvent)?, Footer?
138
139 Element Documentation:
140
Helena 3.5 141 (% style="width:1029.29px" %)
142 |**Name**|**Type**|(% style="width:521px" %)**Documentation**
143 |Header|BasicHeaderType|(% style="width:521px" %)
144 |SubmitRegistrationsRequest|SubmitRegistrationsRequestType|(% style="width:521px" %)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.
145 |SubmitRegistrationsResponse|SubmitRegistrationsResponseType|(% style="width:521px" %)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.
146 |QueryRegistrationRequest|QueryRegistrationRequestType|(% style="width:521px" %)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.
147 |QueryRegistrationResponse|QueryRegistrationResponseType|(% style="width:521px" %)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.
148 |SubmitStructureRequest|SubmitStructureRequestType|(% style="width:521px" %)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.
149 |SubmitStructureResponse|SubmitStructureResponseType|(% style="width:521px" %)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.
150 |SubmitSubscriptionsRequest|SubmitSubscriptionsRequestType|(% style="width:521px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
151 |SubmitSubscriptionsResponse|SubmitSubscriptionsResponseType|(% style="width:521px" %)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.
152 |QuerySubscriptionRequest|QuerySubscriptionRequestType|(% style="width:521px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
153 |QuerySubscriptionResponse|QuerySubscriptionResponseType|(% style="width:521px" %)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.
154 |NotifyRegistryEvent|NotifyRegistryEventType|(% style="width:521px" %)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.
155 |Footer|FooterType|(% style="width:521px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 156
157 **SubmitStructureRequestType:** SubmitStructureRequestType defines the structure of a registry submit structure request document.
158
159 Derivation:
160
161 MessageType (restriction)
Helena 3.1 162 RegistryInterfaceType (restriction)
163 SubmitStructureRequestType
Helena 2.2 164
165 Content:
166 Header, SubmitStructureRequest
167
168 Element Documentation:
169
Helena 3.5 170 (% style="width:1044.29px" %)
171 |**Name**|**Type**|(% style="width:624px" %)**Documentation**
172 |Header|BasicHeaderType|(% style="width:624px" %)
173 |SubmitStructureRequest|SubmitStructureRequestType|(% style="width:624px" %)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 174
175 **SubmitStructureResponseType:** SubmitStructureResponseType defines the structure of a registry submit registration response document.
176
177 Derivation:
178
179 MessageType (restriction)
Helena 3.1 180 RegistryInterfaceType (restriction)
181 SubmitStructureResponseType
Helena 2.2 182
183 Content:
184 Header, SubmitStructureResponse, Footer?
185
186 Element Documentation:
187
Helena 3.5 188 (% style="width:1027.29px" %)
189 |**Name**|**Type**|(% style="width:549px" %)**Documentation**
190 |Header|BasicHeaderType|(% style="width:549px" %)
191 |SubmitStructureResponse|SubmitStructureResponseType|(% style="width:549px" %)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.
192 |Footer|FooterType|(% style="width:549px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
Helena 2.2 193
194 **ErrorType:** ErrorType describes the structure of an error response.
195
196 Content:
197 ErrorMessage+
198
199 Element Documentation:
200
Helena 3.5 201 (% style="width:1039.29px" %)
202 |**Name**|**Type**|**Documentation**
203 |ErrorMessage|CodedStatusMessageType|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.
Helena 2.2 204
205 ***BaseHeaderType*:** BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this
206
207 Content:
208 ID, Test, Prepared, Sender, Receiver*, Name*, Structure*, DataProvider?, MetadataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source
209
210 Element Documentation:
211
Helena 3.5 212 (% style="width:1010.29px" %)
213 |**Name**|**Type**|(% style="width:612px" %)**Documentation**
214 |ID|IDType|(% style="width:612px" %)ID identifies an identification for the message, assigned by the sender.
215 |Test|xs:boolean|(% style="width:612px" %)Test indicates whether the message is for test purposes or not.
216 |Prepared|HeaderTimeType|(% style="width:612px" %)Prepared is the date the message was prepared.
217 |Sender|SenderType|(% style="width:612px" %)Sender is information about the party that is transmitting the message.
218 |Receiver|PartyType|(% style="width:612px" %)Receiver is information about the party that is the intended recipient of the message.
219 |Name|TextType|(% style="width:612px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
220 |Structure|*PayloadStructureType*|(% style="width:612px" %)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.
221 |DataProvider|DataProviderReferenceType|(% style="width:612px" %)DataProvider identifies the provider of the data for a data message.
222 |MetadataProvider|MetadataProviderReferenceType|(% style="width:612px" %)MetadataProvider identifies the provider of the metadata for a metadata message.
223 |DataSetAction|ActionType|(% style="width:612px" %)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).
224 |DataSetID|IDType|(% style="width:612px" %)DataSetID provides an identifier for a contained data set.
225 |Extracted|xs:dateTime|(% style="width:612px" %)Extracted is a time-stamp from the system rendering the data.
226 |ReportingBegin|ObservationalTimePeriodType|(% style="width:612px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
227 |ReportingEnd|ObservationalTimePeriodType|(% style="width:612px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
228 |EmbargoDate|xs:dateTime|(% style="width:612px" %)EmbargoDate holds a time period before which the data included in this message is not available.
229 |Source|TextType|(% style="width:612px" %)Source provides human-readable information about the source of the data.
Helena 2.2 230
231 **StructureHeaderType:** StructureHeaderType defines the structure for structural metadata messages.
232
233 Derivation:
234
235 BaseHeaderType (restriction)
Helena 3.1 236 StructureHeaderType
Helena 2.2 237
238 Content:
239 ID, Test, Prepared, Sender, Receiver*, Name*, Source
240
241 Element Documentation:
242
Helena 3.5 243 (% style="width:1018.29px" %)
244 |**Name**|(% style="width:200px" %)**Type**|(% style="width:706px" %)**Documentation**
245 |ID|(% style="width:200px" %)IDType|(% style="width:706px" %)ID identifies an identification for the message, assigned by the sender.
246 |Test|(% style="width:200px" %)xs:boolean|(% style="width:706px" %)Test indicates whether the message is for test purposes or not.
247 |Prepared|(% style="width:200px" %)HeaderTimeType|(% style="width:706px" %)Prepared is the date the message was prepared.
248 |Sender|(% style="width:200px" %)SenderType|(% style="width:706px" %)Sender is information about the party that is transmitting the message.
249 |Receiver|(% style="width:200px" %)PartyType|(% style="width:706px" %)Receiver is information about the party that is the intended recipient of the message.
250 |Name|(% style="width:200px" %)TextType|(% style="width:706px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
251 |Source|(% style="width:200px" %)TextType|(% style="width:706px" %)Source provides human-readable information about the source of the data.
Helena 2.2 252
253 **StructureSpecificDataHeaderType:** StructureSpecificDataHeaderType defines the header structure for a structure specific data message.
254
255 Derivation:
256
257 BaseHeaderType (restriction)
Helena 3.1 258 StructureSpecificDataHeaderType
Helena 2.2 259
260 Content:
261 ID, Test, Prepared, Sender, Receiver*, Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source
262
263 Element Documentation:
264
Helena 3.5 265 (% style="width:1024.29px" %)
266 |**Name**|**Type**|(% style="width:622px" %)**Documentation**
267 |ID|IDType|(% style="width:622px" %)ID identifies an identification for the message, assigned by the sender.
268 |Test|xs:boolean|(% style="width:622px" %)Test indicates whether the message is for test purposes or not.
269 |Prepared|HeaderTimeType|(% style="width:622px" %)Prepared is the date the message was prepared.
270 |Sender|SenderType|(% style="width:622px" %)Sender is information about the party that is transmitting the message.
271 |Receiver|PartyType|(% style="width:622px" %)Receiver is information about the party that is the intended recipient of the message.
272 |Name|TextType|(% style="width:622px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
273 |Structure|StructureSpecificDataStructureType|(% style="width:622px" %)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.
274 |DataProvider|DataProviderReferenceType|(% style="width:622px" %)DataProvider identifies the provider of the data for a data message.
275 |DataSetAction|ActionType|(% style="width:622px" %)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).
276 |DataSetID|IDType|(% style="width:622px" %)DataSetID provides an identifier for a contained data set.
277 |Extracted|xs:dateTime|(% style="width:622px" %)Extracted is a time-stamp from the system rendering the data.
278 |ReportingBegin|ObservationalTimePeriodType|(% style="width:622px" %)ReportingBegin provides the start of the time period covered by the message (in the case of data).
279 |ReportingEnd|ObservationalTimePeriodType|(% style="width:622px" %)ReportingEnd provides the end of the time period covered by the message (in the case of data).
280 |EmbargoDate|xs:dateTime|(% style="width:622px" %)EmbargoDate holds a time period before which the data included in this message is not available.
281 |Source|TextType|(% style="width:622px" %)Source provides human-readable information about the source of the data.
Helena 2.2 282
283 **GenericMetadataHeaderType:** GenericMetadataHeaderType defines the header format for generic reference metadata.
284
285 Derivation:
286
287 BaseHeaderType (restriction)
Helena 3.1 288 GenericMetadataHeaderType
Helena 2.2 289
290 Content:
291 ID, Test, Prepared, Sender, Receiver*, Name*, Structure+, MetadataProvider?, DataSetAction?, DataSetID*, Extracted?, Source
292
293 Element Documentation:
294
Helena 3.5 295 (% style="width:1027.29px" %)
296 |**Name**|**Type**|(% style="width:678px" %)**Documentation**
297 |ID|IDType|(% style="width:678px" %)ID identifies an identification for the message, assigned by the sender.
298 |Test|xs:boolean|(% style="width:678px" %)Test indicates whether the message is for test purposes or not.
299 |Prepared|HeaderTimeType|(% style="width:678px" %)Prepared is the date the message was prepared.
300 |Sender|SenderType|(% style="width:678px" %)Sender is information about the party that is transmitting the message.
301 |Receiver|PartyType|(% style="width:678px" %)Receiver is information about the party that is the intended recipient of the message.
302 |Name|TextType|(% style="width:678px" %)Name provides a name for the transmission. Multiple instances allow for parallel language values.
303 |Structure|GenericMetadataStructureType|(% style="width:678px" %)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.
304 |MetadataProvider|MetadataProviderReferenceType|(% style="width:678px" %)MetadataProvider identifies the provider of the metadata for a metadata message.
305 |DataSetAction|ActionType|(% style="width:678px" %)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).
306 |DataSetID|IDType|(% style="width:678px" %)DataSetID provides an identifier for a contained data set.
307 |Extracted|xs:dateTime|(% style="width:678px" %)Extracted is a time-stamp from the system rendering the data.
308 |Source|TextType|(% style="width:678px" %)Source provides human-readable information about the source of the data.
Helena 2.2 309
310 **BasicHeaderType:** BasicHeaderType defines the most basic header information used in simple message exchanges.
311
312 Derivation:
313
314 BaseHeaderType (restriction)
Helena 3.1 315 BasicHeaderType
Helena 2.2 316
317 Content:
318 ID, Test, Prepared, Sender, Receiver
319
320 Element Documentation:
321
Helena 3.1 322 |**Name**|**Type**|**Documentation**|
323 |ID|IDType|ID identifies an identification for the message, assigned by the sender.|
324 |Test|xs:boolean|Test indicates whether the message is for test purposes or not.|
325 |Prepared|HeaderTimeType|Prepared is the date the message was prepared.|
326 |Sender|SenderType|Sender is information about the party that is transmitting the message.|
327 |Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.|
Helena 2.2 328
329 **PartyType:** PartyType defines the information which is sent about various parties such as senders and receivers of messages.
330
331 Attributes:
332 id
333
334 Content:
335 Name*, Contact
336
337 Attribute Documentation:
338
Helena 3.1 339 |**Name**|**Type**|**Documentation**|
340 |id|IDType|The id attribute holds the identification of the party.|
Helena 2.2 341
342 Element Documentation:
343
Helena 3.1 344 |**Name**|**Type**|**Documentation**|
345 |Name|TextType|Name is a human-readable name of the party.|
346 |Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.|
Helena 2.2 347
348 **SenderType:** SenderType extends the basic party structure to add an optional time zone declaration.
349
350 Derivation:
351
352 PartyType (extension)
Helena 3.1 353 SenderType
Helena 2.2 354
355 Attributes:
356 id
357
358 Content:
359 Name*, Contact*, Timezone?
360
361 Attribute Documentation:
362
Helena 3.1 363 |**Name**|**Type**|**Documentation**|
364 |id|IDType|The id attribute holds the identification of the party.|
Helena 2.2 365
366 Element Documentation:
367
Helena 3.1 368 |**Name**|**Type**|**Documentation**|
369 |Name|TextType|Name is a human-readable name of the party.|
370 |Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.|
371 |Timezone|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".|
Helena 2.2 372
373 **ContactType:** ContactType provides defines the contact information about a party.
374
375 Content:
376 Name*, Department*, Role*, (Telephone|Fax|X400|URI|Email)
377
378 Element Documentation:
379
Helena 3.1 380 |**Name**|**Type**|**Documentation**|
381 |Name|TextType|Name contains a human-readable name for the contact.|
382 |Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.|
383 |Role|TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.|
384 |Telephone|xs:string|Telephone holds the telephone number for the contact person.|
385 |Fax|xs:string|Fax holds the fax number for the contact person.|
386 |X400|xs:string|X400 holds the X.400 address for the contact person.|
387 |URI|xs:anyURI|URI holds an information URL for the contact person.|
388 |Email|xs:string|Email holds the email address for the contact person.|
Helena 2.2 389
390 === 2.1.4 Simple Types ===
391
392 **HeaderTimeType:** Provides a union type of xs:date and xs:dateTime for the header fields in the message.
393
394 Union of:
395 xs:dateTime, xs:date.
396
397 == 2.2 Message Footer Namespace ==
398
399 http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer
400
401 === 2.2.1 Summary ===
402
403 Referenced Namespaces:
404
Helena 3.1 405 |**Namespace**|**Prefix**|
406 |http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common|
407 |http://www.w3.org/2001/XMLSchema|xs|
Helena 2.2 408
409 Contents:
410 1 Global Element
411 2 Complex Types
412 1 Simple Type
413
414 === 2.2.2 Global Elements ===
415
416 **Footer (FooterType):** Footer is used to communicate information such as error and warnings after the payload of a message.
417
418 === 2.2.3 Complex Types ===
419
420 **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.
421
422 Content:
423 Message+
424
425 Element Documentation:
426
Helena 3.1 427 |**Name**|**Type**|**Documentation**|
428 |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.|
Helena 2.2 429
430 **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.
431
432 Derivation:
433
434 StatusMessageType (restriction)
Helena 3.1 435 CodedStatusMessageType (extension)
436 FooterMessageType
Helena 2.2 437
438 Attributes:
439 code, severity?
440
441 Content:
442 Text+
443
444 Attribute Documentation:
445
Helena 3.1 446 |**Name**|**Type**|**Documentation**|
447 |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.|
448 |severity|SeverityCodeType| |
Helena 2.2 449
450 Element Documentation:
451
Helena 3.1 452 |**Name**|**Type**|**Documentation**|
453 |Text|TextType|Text contains the text of the message, in parallel language values.|
Helena 2.2 454
455 === 2.2.4 Simple Types ===
456
457 **SeverityCodeType:**
458
459 Derived by restriction of xs:string.
460
461 Enumerations:
462
Helena 3.1 463 |**Value**|**Documentation**|
464 |Error|Error indicates the status message coresponds to an error.|
465 |Warning|Warning indicates that the status message corresponds to a warning.|
466 |Information|Information indicates that the status message corresponds to an informational message.|