Interoperability Basis Platform

= 1 Introduction =

At the core of the SDMX XML messages are the message namespaces. These namespaces define the general structure of all messages and define the specific messages that are available for exchange in SDMX.

8

9

There are two namespaces associated with the messages. The main namespace schema which defines every message in SDMX is http://www.sdmx.org/resources/sdmxml/schemas/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 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 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

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

30

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

31

|http://www.sdmx.org/resources/sdmxml/schemas/v3_1/data/structurespecific|dsd|

32

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

33

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

34

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

35

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

36

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

Contents:

7 Global Elements

16 Complex Types

1 Simple Type

=== 2.1.2 Global Elements ===

44

45

**Structure (StructureType):** Structure is a message that contains structural metadata. It may contain any of the following; categorisations, category schemes, code lists, concepts (concept schemes), data and metadata constraints, data flows, hierarchical code lists, metadata flows, metadata structure definitions, organisation schemes, processes, reporting taxonomies, structure maps, representation maps, .

46

47

**StructureSpecificData (StructureSpecificDataType):** StructureSpecificData is used to convey data structure specific according to data structure definition. The payload of this message (i.e. the data sets) will be based on XML schemas which are specific to the data structure definition and the orientation (i.e. the observation dimension) of the data.

48

49

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

50

51

**RegistryInterface (RegistryInterfaceType):** RegistryInterface is used to conduct all interactions with the SDMX Registry Services.

52

53

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

54

55

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

56

57

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

58

59

=== 2.1.3 Complex Types ===

60

61

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

66

67

Element Documentation:

68

69

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

70

|Header|*BaseHeaderType*||

71

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

72

73

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

82

83

Element Documentation:

84

85

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

86

|Header|StructureHeaderType||

87

|Structures|StructuresType||

88

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

89

90

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

95

StructureSpecificDataType

96

97

Content:

98

Header, DataSet*, Footer?

99

100

Element Documentation:

101

102

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

103

|Header|StructureSpecificDat aHeaderType||

104

|DataSet|*DataSetType*||

105

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

106

107

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

Derivation:

MessageType (restriction)

GenericMetadataType

Content:

Header, MetadataSet*, Footer?

116

117

Element Documentation:

118

119

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

120

|Header|GenericMetadataHeade rType||

121

|MetadataSet|MetadataSetType||

122

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

123

124

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

Derivation:

MessageType (restriction)

129

RegistryInterfaceType

Content:

Element Documentation:

135

136

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

137

|Header|BasicHeaderType||

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

151

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

Derivation:

MessageType (restriction)

156

RegistryInterfaceType (restriction)

157

SubmitStructureRequestType

158

159

Content:

160

Header, SubmitStructureRequest

161

162

Element Documentation:

163

164

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

165

|Header|BasicHeaderType||

166

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

167

168

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

Derivation:

MessageType (restriction)

173

RegistryInterfaceType (restriction)

174

SubmitStructureResponseType

175

176

Content:

177

Header, SubmitStructureResponse, Footer?

178

179

Element Documentation:

180

181

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

182

|Header|BasicHeaderType||

183

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

184

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

185

186

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

Content:

ErrorMessage+

Element Documentation:

192

193

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

194

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

195

196

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

197

198

Content:

199

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

200

201

Element Documentation:

202

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

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

211

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

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

221

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

Derivation:

BaseHeaderType (restriction)

StructureHeaderType

Content:

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

230

231

Element Documentation:

232

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

242

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

Derivation:

BaseHeaderType (restriction)

247

StructureSpecificDataHeaderType

248

249

Content:

250

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

251

252

Element Documentation:

253

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

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

262

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

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

271

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

Derivation:

BaseHeaderType (restriction)

276

GenericMetadataHeaderType

277

278

Content:

279

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

280

281

Element Documentation:

282

283

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

284

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

285

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

286

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

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

297

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

Derivation:

BaseHeaderType (restriction)

BasicHeaderType

Content:

ID, Test, Prepared, Sender, Receiver

306

307

Element Documentation:

308

309

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

310

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

311

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

312

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

313

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

314

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

315

316

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

325

326

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

327

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

328

329

Element Documentation:

330

331

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

332

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

333

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

334

335

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

Derivation:

PartyType (extension)

SenderType

Attributes:

id

Content:

Name*, Contact*, Timezone?

347

348

Attribute Documentation:

349

350

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

351

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

352

353

Element Documentation:

354

355

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

356

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

357

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

358

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

359

360

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

361

362

Content:

363

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

364

365

Element Documentation:

366

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

377

=== 2.1.4 Simple Types ===

378

379

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

380

381

Union of:

382

xs:dateTime, xs:date.

383

384

== 2.2 Message Footer Namespace ==

385

386

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

387

388

=== 2.2.1 Summary ===

389

390

Referenced Namespaces:

391

392

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

393

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

394

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

Contents:

1 Global Element

2 Complex Types

1 Simple Type

=== 2.2.2 Global Elements ===

402

403

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

404

405

=== 2.2.3 Complex Types ===

406

407

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

413

414

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

415

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

416

417

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

422

CodedStatusMessageType (extension)

FooterMessageType

Attributes:

code, severity?

Content:

Text+

Attribute Documentation:

432

433

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

434

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

435

|severity|SeverityCodeType||

436

437

Element Documentation:

438

439

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

440

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

441

442