Interoperability Basis Platform

= 1 Introduction =

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]].

8

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.

10

11

In general, every message in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] follows common format of:

* Header

* Payload (0..n)

* Footer (0..1)

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

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

Contents:

7 Global Elements

16 Complex Types

1 Simple Type

=== 2.1.2 Global Elements ===

45

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(%%), .

47

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.

49

50

**GenericMetadata (GenericMetadataType):** GenericMetadata contains reported metadata in a format which supports any metadata structure definition.

51

52

**RegistryInterface (RegistryInterfaceType):** RegistryInterface is used to conduct all interactions with the [[SDMX Registry>>doc:sdmx:Glossary.SDMX Registry.WebHome]] Services.

53

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.

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.

Content:

Header, {any element with namespace of http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message}*, Footer?

67

68

Element Documentation:

69

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.

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.

Derivation:

MessageType (restriction)

StructureType

Content:

Header, Structures?, Footer?

84

85

Element Documentation:

86

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.

92

93

**StructureSpecificDataType:** StructureSpecificDataType defines the structure of the structure specific data message. Note that the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] 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.

Derivation:

MessageType (restriction)

98

StructureSpecificDataType

99

100

Content:

101

Header, [[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]*, Footer?

102

103

Element Documentation:

104

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>>doc:sdmx:Glossary.Data set.WebHome]]|(% 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.

110

111

**GenericMetadataType:** GenericMetadataType defines the contents of a generic metadata message.

Derivation:

MessageType (restriction)

GenericMetadataType

Content:

Header, MetadataSet*, Footer?

120

121

Element Documentation:

122

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.

128

129

**RegistryInterfaceType:** This is a type which describes a structure for holding all of the various dedicated registry interface message types.

Derivation:

MessageType (restriction)

134

RegistryInterfaceType

Content:

Element Documentation:

140

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>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. The [[data source>>doc:sdmx:Glossary.Data source.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]] and [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]]. It specifies whether the result set should include [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]], [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], or both. The search can be characterized by providing (% style="color:#e74c3c" %)constraints(%%) including [[reference periods>>doc:sdmx:Glossary.Reference period.WebHome]], 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, (% 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.

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>>doc:sdmx:Glossary.Subscription.WebHome]] request. It contains information which describes the success or failure of each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, providing any error messages in the event of failure. If successful, it returns the registry URN of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and the subscriber-assigned ID.

152

|QuerySubscriptionRequest|QuerySubscriptionRequestType|(% style="width:521px" %)QuerySubscriptionRequest is used to query the registry for the [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] of a given organisation.

153

|QuerySubscriptionResponse|QuerySubscriptionResponseType|(% style="width:521px" %)QuerySubscriptionResponse is sent as a response to a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] query. If the query is successful, the details of all [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]] that triggered the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] 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.

156

157

**SubmitStructureRequestType:** SubmitStructureRequestType defines the structure of a registry submit structure request document.

Derivation:

MessageType (restriction)

162

RegistryInterfaceType (restriction)

163

SubmitStructureRequestType

164

165

Content:

166

Header, SubmitStructureRequest

167

168

Element Documentation:

169

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, (% 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.

174

175

**SubmitStructureResponseType:** SubmitStructureResponseType defines the structure of a registry submit registration response document.

Derivation:

MessageType (restriction)

180

RegistryInterfaceType (restriction)

181

SubmitStructureResponseType

182

183

Content:

184

Header, SubmitStructureResponse, Footer?

185

186

Element Documentation:

187

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.

193

194

**ErrorType:** ErrorType describes the structure of an error response.

Content:

ErrorMessage+

Element Documentation:

200

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>>doc:sdmx:Glossary.Code.WebHome]] in order to distinguish message for unique errors.

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

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>>doc:sdmx:Glossary.Reference metadata.WebHome]]. 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>>doc:sdmx:Glossary.Dimension.WebHome]] is being used at the observation (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Metadata set.WebHome]] 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>>doc:sdmx:Glossary.Code.WebHome]] provides a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]].

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>>doc:sdmx:Glossary.Time period.WebHome]] covered by the message (in the case of data).

227

|ReportingEnd|ObservationalTimePeriodType|(% style="width:612px" %)ReportingEnd provides the end of the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] covered by the message (in the case of data).

228

|EmbargoDate|xs:dateTime|(% style="width:612px" %)EmbargoDate holds a [[time period>>doc:sdmx:Glossary.Time period.WebHome]] 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.

230

231

**StructureHeaderType:** StructureHeaderType defines the structure for [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] messages.

Derivation:

BaseHeaderType (restriction)

StructureHeaderType

Content:

ID, Test, Prepared, Sender, Receiver*, Name*, Source

240

241

Element Documentation:

242

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.

252

253

**StructureSpecificDataHeaderType:** StructureSpecificDataHeaderType defines the header structure for a structure specific data message.

Derivation:

BaseHeaderType (restriction)

258

StructureSpecificDataHeaderType

259

260

Content:

261

ID, Test, Prepared, Sender, Receiver*, Name*, Structure+, DataProvider?, DataSetAction?, DataSetID*, Extracted?, ReportingBegin?, ReportingEnd?, EmbargoDate?, Source

262

263

Element Documentation:

264

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>>doc:sdmx:Glossary.Reference metadata.WebHome]]. 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>>doc:sdmx:Glossary.Dimension.WebHome]] is being used at the observation (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Metadata set.WebHome]] 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>>doc:sdmx:Glossary.Code.WebHome]] provides a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]].

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>>doc:sdmx:Glossary.Time period.WebHome]] covered by the message (in the case of data).

279

|ReportingEnd|ObservationalTimePeriodType|(% style="width:622px" %)ReportingEnd provides the end of the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] covered by the message (in the case of data).

280

|EmbargoDate|xs:dateTime|(% style="width:622px" %)EmbargoDate holds a [[time period>>doc:sdmx:Glossary.Time period.WebHome]] 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.

282

283

**GenericMetadataHeaderType:** GenericMetadataHeaderType defines the header format for generic [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]].

Derivation:

BaseHeaderType (restriction)

288

GenericMetadataHeaderType

289

290

Content:

291

ID, Test, Prepared, Sender, Receiver*, Name*, Structure+, MetadataProvider?, DataSetAction?, DataSetID*, Extracted?, Source

292

293

Element Documentation:

294

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>>doc:sdmx:Glossary.Reference metadata.WebHome]]. 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>>doc:sdmx:Glossary.Dimension.WebHome]] is being used at the observation (% style="color:#e74c3c" %)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>>doc:sdmx:Glossary.Metadata set.WebHome]] 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>>doc:sdmx:Glossary.Code.WebHome]] provides a [[code>>doc:sdmx:Glossary.Code.WebHome]] 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>>doc:sdmx:Glossary.Data set.WebHome]].

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.

309

310

**BasicHeaderType:** BasicHeaderType defines the most basic header information used in simple message exchanges.

Derivation:

BaseHeaderType (restriction)

BasicHeaderType

Content:

ID, Test, Prepared, Sender, Receiver

319

320

Element Documentation:

321

322

(% style="width:1002.29px" %)

323

|**Name**|**Type**|**Documentation**

324

|ID|IDType|ID identifies an identification for the message, assigned by the sender.

325

|Test|xs:boolean|Test indicates whether the message is for test purposes or not.

326

|Prepared|HeaderTimeType|Prepared is the date the message was prepared.

327

|Sender|SenderType|Sender is information about the party that is transmitting the message.

328

|Receiver|PartyType|Receiver is information about the party that is the intended recipient of the message.

329

330

**PartyType:** PartyType defines the information which is sent about various parties such as senders and receivers of messages.

Attributes:

id

Content:

Name*, (% style="color:#e74c3c" %)Contact

337

338

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

339

340

(% style="width:973.294px" %)

341

|**Name**|**Type**|**Documentation**

342

|id|IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the party.

343

344

Element Documentation:

345

346

(% style="width:975.294px" %)

347

|(% style="width:114px" %)**Name**|(% style="width:132px" %)**Type**|(% style="width:727px" %)**Documentation**

348

|(% style="width:114px" %)Name|(% style="width:132px" %)TextType|(% style="width:727px" %)Name is a human-readable name of the party.

349

|(% style="width:114px" %)(% style="color:#e74c3c" %)Contact|(% style="width:132px" %)ContactType|(% style="width:727px" %)(% style="color:#e74c3c" %)Contact(%%) provides (% style="color:#e74c3c" %)contact(%%) information for the party in regard to the transmission of the message.

350

351

**SenderType:** SenderType extends the basic party structure to add an optional time zone declaration.

Derivation:

PartyType (extension)

SenderType

Attributes:

id

Content:

Name*, (% style="color:#e74c3c" %)Contact(%%)*, Timezone?

363

364

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

365

366

(% style="width:1000.29px" %)

367

|**Name**|**Type**|**Documentation**

368

|id|IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds the identification of the party.

369

370

Element Documentation:

371

372

(% style="width:1003.29px" %)

373

|**Name**|**Type**|**Documentation**

374

|Name|TextType|Name is a human-readable name of the party.

375

|(%%)(% style="color:#e74c3c" %)Contact|ContactType|(%%)(% style="color:#e74c3c" %)Contact(%%) provides (% style="color:#e74c3c" %)contact(%%) information for the party in regard to the transmission of the message.

376

|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".

377

378

**ContactType:** ContactType provides defines the (% style="color:#e74c3c" %)contact(%%) information about a party.

379

380

Content:

381

Name*, Department*, Role*, (Telephone|Fax|X400|URI|Email)

382

383

Element Documentation:

384

385

(% style="width:1002.29px" %)

386

|**Name**|**Type**|**Documentation**

387

|Name|TextType|Name contains a human-readable name for the (% style="color:#e74c3c" %)contact(%%).

388

|Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the (% style="color:#e74c3c" %)contact(%%) person works.

389

|Role|TextType|Role is the responsibility of the (% style="color:#e74c3c" %)contact(%%) person with respect to the object for which this person is the (% style="color:#e74c3c" %)contact(%%).

390

|Telephone|xs:string|Telephone holds the [[telephone number>>doc:sdmx:Glossary.Contact phone number.WebHome]] for the (% style="color:#e74c3c" %)contact(%%) person.

391

|Fax|xs:string|Fax holds the fax number for the (% style="color:#e74c3c" %)contact(%%) person.

392

|X400|xs:string|X400 holds the X.400 address for the (% style="color:#e74c3c" %)contact(%%) person.

393

|URI|xs:anyURI|URI holds an information URL for the (% style="color:#e74c3c" %)contact(%%) person.

394

|Email|xs:string|Email holds the email address for the (% style="color:#e74c3c" %)contact(%%) person.

395

396

=== 2.1.4 Simple Types ===

397

398

**HeaderTimeType:** Provides a union type of xs:date and xs:dateTime for the header fields in the message.

399

400

Union of:

401

xs:dateTime, xs:date.

402

403

== 2.2 Message Footer Namespace ==

404

405

http://www.sdmx.org/resources/sdmxml/schemas/v3_1/message/footer

406

407

=== 2.2.1 Summary ===

408

409

Referenced Namespaces:

410

411

(% style="width:970.294px" %)

412

|(% style="width:495px" %)**Namespace**|(% style="width:472px" %)**Prefix**

413

|(% style="width:495px" %)http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|(% style="width:472px" %)common

414

|(% style="width:495px" %)http://www.w3.org/2001/XMLSchema|(% style="width:472px" %)xs

Contents:

1 Global Element

2 Complex Types

1 Simple Type

=== 2.2.2 Global Elements ===

422

423

**Footer (FooterType):** Footer is used to communicate information such as error and warnings after the payload of a message.

424

425

=== 2.2.3 Complex Types ===

426

427

**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.

Content:

Message+

Element Documentation:

433

434

(% style="width:1005.29px" %)

435

|**Name**|**Type**|**Documentation**

436

|Message|FooterMessageType|Message contains a single error, information, or warning message. A [[code>>doc:sdmx:Glossary.Code.WebHome]] is provided along with an optional severity. The text of the message can be expressed in multiple languages.

437

438

**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>>doc:sdmx:Glossary.Code.WebHome]] of Error, Information, or Warning added to it.

Derivation:

StatusMessageType (restriction)

443

CodedStatusMessageType (extension)

FooterMessageType

Attributes:

[[code>>doc:sdmx:Glossary.Code.WebHome]], severity?

Content:

Text+

[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:

453

454

(% style="width:1008.29px" %)

455

|**Name**|**Type**|(% style="width:785px" %)**Documentation**

456

|[[code>>doc:sdmx:Glossary.Code.WebHome]]|xs:string|(% style="width:785px" %)The [[code>>doc:sdmx:Glossary.Code.WebHome]] [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds an optional [[code>>doc:sdmx:Glossary.Code.WebHome]] 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.

457

|severity|SeverityCodeType|(% style="width:785px" %)

458

459

Element Documentation:

460

461

(% style="width:1015.29px" %)

462

|**Name**|**Type**|(% style="width:542px" %)**Documentation**

463

|Text|TextType|(% style="width:542px" %)Text contains the text of the message, in parallel language values.