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 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*, Footer?

102

103

Element Documentation:

104

105

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

106

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

107

|Header|(% style="width:327px" %)StructureSpecificDat aHeaderType|(% style="width:755px" %)

108

|DataSet|(% style="width:327px" %)*DataSetType*|(% style="width:755px" %)

109

|Footer|(% style="width:327px" %)FooterType|(% style="width:755px" %)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

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

124

|Header|GenericMetadataHeade rType| |

125

|MetadataSet|MetadataSetType| |

126

|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.|

127

128

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

Derivation:

MessageType (restriction)

133

RegistryInterfaceType

Content:

Element Documentation:

139

140

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

141

|Header|BasicHeaderType| |

142

|SubmitRegistrationsR equest|SubmitRegistrationsR equestType|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.|

143

|SubmitRegistrationsR esponse|SubmitRegistrationsR esponseType|SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.|

144

|QueryRegistrationReq uest|QueryRegistrationReq uestType|QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.|

145

|QueryRegistrationRes ponse|QueryRegistrationRes ponseType|QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.|

146

|SubmitStructureReque st|SubmitStructureReque stType|SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.|

147

|SubmitStructureRespo nse|SubmitStructureRespo nseType|SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.|

148

|SubmitSubscriptionsR equest|SubmitSubscriptionsR equestType|SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.|

149

|SubmitSubscriptionsR esponse|SubmitSubscriptionsR esponseType|SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.|

150

|QuerySubscriptionReq uest|QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.|

151

|QuerySubscriptionRes ponse|QuerySubscriptionRes ponseType|QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.|

152

|NotifyRegistryEvent|NotifyRegistryEventT ype|NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.|

153

|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.|

154

155

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

Derivation:

MessageType (restriction)

160

RegistryInterfaceType (restriction)

161

SubmitStructureRequestType

162

163

Content:

164

Header, SubmitStructureRequest

165

166

Element Documentation:

167

168

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

169

|Header|BasicHeaderType| |

170

|SubmitStructureReque st|SubmitStructureReque stType|SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.|

171

172

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

Derivation:

MessageType (restriction)

177

RegistryInterfaceType (restriction)

178

SubmitStructureResponseType

179

180

Content:

181

Header, SubmitStructureResponse, Footer?

182

183

Element Documentation:

184

185

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

186

|Header|BasicHeaderType| |

187

|SubmitStructureRespo nse|SubmitStructureRespo nseType|SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.|

188

|Footer|FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.|

189

190

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

Content:

ErrorMessage+

Element Documentation:

196

197

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

198

|ErrorMessage|CodedStatusMessageTy pe|ErrorMessage contains the error message. It can occur multiple times to communicate message for multiple errors, or to communicate the error message in parallel languages. If both messages for multiple errors and parallel language messages are used, then each error message should be given a code in order to distinguish message for unique errors.|

199

200

***BaseHeaderType*:** BaseHeaderType in an abstract base type that defines the basis for all message headers. Specific message formats will refine this

201

202

Content:

203

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

204

205

Element Documentation:

206

207

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

208

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

209

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

210

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

211

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

212

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

213

|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.|

214

|Structure|*PayloadStructureType*|Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.|

215

|DataProvider|DataProviderReferenc eType|DataProvider identifies the provider of the data for a data message.|

216

|MetadataProvider|MetadataProviderRefe renceType|MetadataProvider identifies the provider of the metadata for a metadata message.|

217

|DataSetAction|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).|

218

|DataSetID|IDType|DataSetID provides an identifier for a contained data set.|

219

|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.|

220

|ReportingBegin|ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).|

221

|ReportingEnd|ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).|

222

|EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.|

223

|Source|TextType|Source provides human-readable information about the source of the data.|

224

225

**StructureHeaderType:** StructureHeaderType defines the structure for structural metadata messages.

Derivation:

BaseHeaderType (restriction)

StructureHeaderType

Content:

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

234

235

Element Documentation:

236

237

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

238

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

239

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

240

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

241

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

242

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

243

|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.|

244

|Source|TextType|Source provides human-readable information about the source of the data.|

245

246

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

Derivation:

BaseHeaderType (restriction)

251

StructureSpecificDataHeaderType

252

253

Content:

254

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

255

256

Element Documentation:

257

258

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

259

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

260

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

261

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

262

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

263

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

264

|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.|

265

|Structure|StructureSpecificDat aStructureType|Structure provides a reference to the structure (either explicitly or through a structure usage reference) that describes the format of data or reference metadata. In addition to the structure, it is required to also supply the namespace of the structure specific schema that defines the format of the data/metadata. For cross sectional data, additional information is also required to state which dimension is being used at the observation level. This information will allow the structure specific schema to be generated. For generic format messages, this is used to simply reference the underlying structure. It is not mandatory in these cases and the generic data/metadata sets will require this reference explicitly.|

266

|DataProvider|DataProviderReferenc eType|DataProvider identifies the provider of the data for a data message.|

267

|DataSetAction|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).|

268

|DataSetID|IDType|DataSetID provides an identifier for a contained data set.|

269

|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.|

270

|ReportingBegin|ObservationalTimePer iodType|ReportingBegin provides the start of the time period covered by the message (in the case of data).|

271

|ReportingEnd|ObservationalTimePer iodType|ReportingEnd provides the end of the time period covered by the message (in the case of data).|

272

|EmbargoDate|xs:dateTime|EmbargoDate holds a time period before which the data included in this message is not available.|

273

|Source|TextType|Source provides human-readable information about the source of the data.|

274

275

**GenericMetadataHeaderType:** GenericMetadataHeaderType defines the header format for generic reference metadata.

Derivation:

BaseHeaderType (restriction)

280

GenericMetadataHeaderType

281

282

Content:

283

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

284

285

Element Documentation:

286

287

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

288

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

289

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

290

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

291

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

292

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

293

|Name|TextType|Name provides a name for the transmission. Multiple instances allow for parallel language values.|

294

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

295

|MetadataProvider|MetadataProviderRefe renceType|MetadataProvider identifies the provider of the metadata for a metadata message.|

296

|DataSetAction|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).|

297

|DataSetID|IDType|DataSetID provides an identifier for a contained data set.|

298

|Extracted|xs:dateTime|Extracted is a time-stamp from the system rendering the data.|

299

|Source|TextType|Source provides human-readable information about the source of the data.|

300

301

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

Derivation:

BaseHeaderType (restriction)

BasicHeaderType

Content:

ID, Test, Prepared, Sender, Receiver

310

311

Element Documentation:

312

313

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

314

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

315

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

316

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

317

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

318

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

319

320

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

Attributes:

id

Content:

Name*, Contact

Attribute Documentation:

329

330

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

331

|id|IDType|The id attribute holds the identification of the party.|

332

333

Element Documentation:

334

335

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

336

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

337

|Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.|

338

339

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

Derivation:

PartyType (extension)

SenderType

Attributes:

id

Content:

Name*, Contact*, Timezone?

351

352

Attribute Documentation:

353

354

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

355

|id|IDType|The id attribute holds the identification of the party.|

356

357

Element Documentation:

358

359

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

360

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

361

|Contact|ContactType|Contact provides contact information for the party in regard to the transmission of the message.|

362

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

363

364

**ContactType:** ContactType provides defines the contact information about a party.

365

366

Content:

367

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

368

369

Element Documentation:

370

371

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

372

|Name|TextType|Name contains a human-readable name for the contact.|

373

|Department|TextType|Department is designation of the organisational structure by a linguistic expression, within which the contact person works.|

374

|Role|TextType|Role is the responsibility of the contact person with respect to the object for which this person is the contact.|

375

|Telephone|xs:string|Telephone holds the telephone number for the contact person.|

376

|Fax|xs:string|Fax holds the fax number for the contact person.|

377

|X400|xs:string|X400 holds the X.400 address for the contact person.|

378

|URI|xs:anyURI|URI holds an information URL for the contact person.|

379

|Email|xs:string|Email holds the email address for the contact person.|

380

381

=== 2.1.4 Simple Types ===

382

383

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

384

385

Union of:

386

xs:dateTime, xs:date.

387

388

== 2.2 Message Footer Namespace ==

389

390

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

391

392

=== 2.2.1 Summary ===

393

394

Referenced Namespaces:

395

396

|**Namespace**|**Prefix**|

397

|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/common|common|

398

|http://www.w3.org/2001/XMLSchema|xs|

Contents:

1 Global Element

2 Complex Types

1 Simple Type

=== 2.2.2 Global Elements ===

406

407

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

408

409

=== 2.2.3 Complex Types ===

410

411

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

417

418

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

419

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

420

421

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

Derivation:

StatusMessageType (restriction)

426

CodedStatusMessageType (extension)

FooterMessageType

Attributes:

code, severity?

Content:

Text+

Attribute Documentation:

436

437

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

438

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

439

|severity|SeverityCodeType| |

440

441

Element Documentation:

442

443

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

444

|Text|TextType|Text contains the text of the message, in parallel language values.|

445

446