Interoperability Basis Platform

= 1 Introduction =

The registry schemas have been updated to reflect the various changes in the standard and to introduce new constructs for managing [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]]. In addtion, the constructs that had existed for querying [[structural metadata>>doc:sdmx:Glossary.Structural metadata.WebHome]] have been removed as this is now handled by the query messages.

8

9

As was done with the query, the registry message set now contains distinct messages for each operation. The messages will eventually allow the registry to function in more standard web service mannter.

10

11

= 2 Schema Documentation =

12

13

== 2.1 Registry Namespace ==

14

15

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

16

17

=== 2.1.1 Summary ===

18

19

Referenced Namespaces:

20

21

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

22

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

23

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

24

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

Contents:

39 Complex Types

5 Simple Types

=== 2.1.2 Complex Types ===

31

32

**RegistrationType:** Registration provides the information needed for data and [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] set registration. A [[data source>>doc:sdmx:Glossary.Data source.WebHome]] must be supplied here if not already provided in the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]]. The [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] must be associated with a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]], or a [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] definition. If possible, the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] should be specified. Only in cases where this is not possible should the [[dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] or [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] be used.

33

34

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

35

id?, validFrom?, validTo?, lastUpdated?, indexTimeSeries?, indexDataSet?, indexAttributes?, indexReportingPeriod?

36

37

Content:

38

ProvisionAgreement, Datasource

39

40

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

41

42

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

43

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

44

|id|IDType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] holds a registry assigned identification for the registration. This must be provided in a response message (unless an error occurred while submitting a new registration), and should be included when updating or deleting a registration.

45

|validFrom|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides an inclusive start date for providing supplemental validity information about the registration, so that data visibility from the registry can be controlled by the registrant.

46

|validTo|xs:dateTime|The validFrom [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides an inclusive end date for providing supplemental validity information about the registration, so that data visibility from the registry can be controlled by the registrant.

47

|lastUpdated|xs:dateTime|The lastUpdated [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] provides a timestamp for the last time the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] was updated.

48

|indexTimeSeries (default: false)|xs:boolean|The indexTimeSeries, if true, indicates that the registry must index all time series for the registered data. The default value is false, and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will always be assumed false when the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] references a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]].

49

|indexDataSet (default: false)|xs:boolean|The indexDataSet, if true, indicates that the registry must index the range of actual (present) values for each [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or identifier [[component>>doc:sdmx:Glossary.Component.WebHome]] of the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] (as indicated in the set's structure definition). The default value is false.

50

|indexAttributes (default: false)|xs:boolean|The indexAttributes, if true, indicates that the registry must index the range of actual (present) values for each [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or the presence of the metadata [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] of the [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] (as indicated in the set's structure definition). The default value is false.

51

|indexReportingPeriod (default: false)|xs:boolean|The indexReportingPeriod, if true, indicates that the registry must index the [[time period>>doc:sdmx:Glossary.Time period.WebHome]] ranges for which data is present for the [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. The default value is false, and the [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will always be assumed false when the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] references a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]].

52

53

Element Documentation:

54

55

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

56

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

57

|ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreement provides a reference to the [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] that the data is being registered against.

58

|Datasource|DataSourceType|Datasource identifies the [[data source>>doc:sdmx:Glossary.Data source.WebHome]](s) where the registered data can be retrieved.

59

60

**DataSourceType:** DataSourceType specifies the properties of a data or metadata source. Either a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]], a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]], or both must be specified.

61

62

Content:

63

(SimpleDataSource|QueryableDataSource)[1..2]

64

65

Element Documentation:

66

67

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

68

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

69

|SimpleDataSource|(% style="width:221px" %)xs:anyURI|(% style="width:536px" %)SimpleDatasource describes a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that is an [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] data or metadata message. It requires only the URL of the data.

70

|QueryableDataSource|(% style="width:221px" %)QueryableDataSourceType|(% style="width:536px" %)QueryableDatasource describes a [[data source>>doc:sdmx:Glossary.Data source.WebHome]] that can be queried using the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] REST interfaces.

71

72

**SimpleDataSourceType:** SimpleDataSourceType describes a simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. The URL of the data is contained in the content.

Derivation:

xs:anySimpleType (restriction)

77

xs:anyURI (extension)

SimpleDataSourceType

Attributes:

TYPE?

Content:

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

85

86

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

87

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

88

|TYPE (fixed: SIMPLE)|xs:string|TYPE is a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that is used to ensure only one simple [[data source>>doc:sdmx:Glossary.Data source.WebHome]] may be provided, when it is referenced in a uniqueness (% style="color:#e74c3c" %)constraint(%%).

89

90

**QueryableDataSourceType:** QueryableDataSourceType describes a queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]], and add a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] for ensuring only one queryable source can be provided.

Derivation:

QueryableDataSourceType (extension)

95

QueryableDataSourceType

96

97

Attributes:

98

isRESTDatasource, isWebServiceDatasource, TYPE?

99

100

Content:

101

DataURL, WSDLURL?, WADLURL?

102

103

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

104

105

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

106

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

107

|isRESTDatasource|xs:boolean|The isRESTDatasource [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates, if true, that the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is accessible via the REST protocol.

108

|isWebServiceDatasource|xs:boolean|The isWebServiceDatasource [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates, if true, that the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is accessible via Web Services protocols.

109

|TYPE (fixed: QUERY)|xs:string|TYPE is a fixed [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] that is used to ensure only one queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]] may be provided, when it is referenced in a uniqueness (% style="color:#e74c3c" %)constraint(%%).

110

111

Element Documentation:

112

113

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

114

|DataURL|xs:anyURI|DataURL contains the URL of the [[data source>>doc:sdmx:Glossary.Data source.WebHome]].|

115

|WSDLURL|xs:anyURI|WSDLURL provides the location of a WSDL instance on the internet which describes the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]].|

116

|WADLURL|xs:anyURI|WADLURL provides the location of a WADL instance on the internet which describes the REST protocol of the queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]].|

117

118

**IdentifiableQueryType:** IdentifiableQueryType describes the structure of a query for an identifiable object.

Attributes:

id?

Content:

{Empty}

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

127

128

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

129

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

130

|id (default:%)|IDQueryType|The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.

131

132

**VersionableQueryType:** VersionableQueryType describes the structure of a query for a versionable object.

Derivation:

IdentifiableQueryType (extension)

VersionableQueryType

Attributes:

id?, version?

Content:

{Empty}

Attribute Documentation:

146

147

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

148

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

149

|id (default: %)|IDQueryType|(% style="width:775px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.

150

|version (default:\*)|VersionQueryType|(% style="width:775px" %)The (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its (% style="color:#e74c3c" %)version(%%). This can be and explicit value, wild-carded ("%"), or late-bound ("\*"). A wild carded (% style="color:#e74c3c" %)version(%%) will match any (% style="color:#e74c3c" %)version(%%) of the object where as a late-bound (% style="color:#e74c3c" %)version(%%) will only match the latest (% style="color:#e74c3c" %)version(%%).

151

152

**MaintainableQueryType:** MaintainableQueryType describes the structure of a query for a maintainable object.

Derivation:

IdentifiableQueryType (extension)

157

VersionableQueryType (extension)

158

MaintainableQueryType

159

160

Attributes:

161

id?, version?, agencyID?

Content:

{Empty}

Attribute Documentation:

167

168

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

169

|(% style="width:201px" %)**Name**|(% style="width:127px" %)**Type**|(% style="width:789px" %)**Documentation**

170

|(% style="width:201px" %)id (default: %)|(% style="width:127px" %)IDQueryType|(% style="width:789px" %)The id [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its identifier. This is either an explicit value, or completely wild cared with the "%" value.

171

|(% style="width:201px" %)version (default: \*)|(% style="width:127px" %)VersionQueryType|(% style="width:789px" %)The (% style="color:#e74c3c" %)version(%%) [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its (% style="color:#e74c3c" %)version(%%). This can be and explicit value, wild-carded ("%"), or late-bound ("\*"). A wild carded (% style="color:#e74c3c" %)version(%%) will match any (% style="color:#e74c3c" %)version(%%) of the object where as a late-bound (% style="color:#e74c3c" %)version(%%) will only match the latest (% style="color:#e74c3c" %)version(%%).

172

|(% style="width:201px" %)agencyID (default: %)|(% style="width:127px" %)NestedIDQueryType|(% style="width:789px" %)The agencyID [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is used to query for an object based on its [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]]'s identifier. This is either an explicit value, or completely wild cared with the "%" value.

173

174

**StatusMessageType:** StatusMessageType carries the text of error messages and/or warnings in response to queries or requests.

Attributes:

status

Content:

MessageText

Attribute Documentation:

183

184

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

185

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

186

|status|StatusType|The status [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] carries the status of the query or request.

187

188

Element Documentation:

189

190

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

191

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

192

|MessageText|StatusMessageType|MessageText contains the text of the error and/or warning message. It can occur multiple times to communicate message for multiple warnings or errors.

193

194

**SubmitRegistrationsRequestType:** SubmitRegistrationsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of data/[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] registrations.

Content:

RegistrationRequest+

Element Documentation:

200

201

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

202

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

203

|RegistrationRequest|RegistrationRequestType|RegistrationRequest provides the details of a requested registration and the action to take on it. A reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] that exists in the registry must be provide along with a simple and/or queryable [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. The id should only be provided when updating or deleting a registration.

204

205

**RegistrationRequestType:** RegistrationRequestType describes the structure of a single registration request. It contains the details of a registation and an action field to indicate the action to be taken on the contained registration.

Attributes:

action

Content:

Registration

Attribute Documentation:

214

215

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

216

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

217

|action|ActionType|The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this is an addition, a modification, or a deletion of a registration.

218

219

Element Documentation:

220

221

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

222

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

223

|Registration|RegistrationType|Registration contains the details of the data/[[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]] registration to be added, updated, or deleted.

224

225

**SubmitRegistrationsResponseType:** SubmitRegistrationsResponseType describes the structure of a registration response. For each submitted registration in the request, a registration status is provided. The status elements should be provided in the same order as the submitted registrations, although each status will echo the request to ensure accurate processing of the responses.

Content:

RegistrationStatus+

Element Documentation:

231

232

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

233

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

234

|RegistrationStatus|RegistrationStatusTy pe|RegistrationStatus provided the status details for the submitted registration. It echoes the original submission and provides status information about the request.

235

236

**RegistrationStatusType:** RegistrationStatusType describes the structure of a registration status.

237

238

Content:

239

Registration, StatusMessage

240

241

Element Documentation:

242

243

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

244

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

245

|Registration|RegistrationType|(% style="width:578px" %)Registration, at the very least echoes the submitted registration. It the request was to create a new registration and it was successful, an id must be supplied.

246

|StatusMessage|StatusMessageType|(% style="width:578px" %)StatusMessage provides that status for the registration request, and if necessary, any error or warning information.

247

248

**QueryRegistrationRequestType:** QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]], or both) must be specified. It is possible to query for registrations for a particular [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]], or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing (% style="color:#e74c3c" %)constraints(%%) in the form of explicit [[time periods>>doc:sdmx:Glossary.Time period.WebHome]], (% style="color:#e74c3c" %)constraint(%%) regions, and key sets. When (% style="color:#e74c3c" %)constraint(%%) regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions.

Attributes:

returnConstraints?

Content:

Attribute Documentation:

257

258

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

259

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

260

|returnConstraints (default: false)|xs:boolean|The returnConstraints [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] determines whether information about the (% style="color:#e74c3c" %)constraints(%%) on the data or [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]] returned should also be sent the results.

261

262

Element Documentation:

263

264

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

265

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

266

|QueryType|QueryTypeType|QueryType defines the type of sets (data, metadata, or both) that are being queried for.

267

|All|EmptyType|All indicates that all registrations meeting the other criteria of the query should be returned.

268

|ProvisionAgreement|ProvisionAgreementReferenceType|ProvisionAgreement provides a reference to a [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.

269

|DataProvider|DataProviderReferenceType|DataProvider provides a reference to a [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.

270

|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]]|DataflowReferenceType|[[Dataflow>>doc:sdmx:Glossary.Dataflow.WebHome]] provides a reference to a [[data flow>>doc:sdmx:Glossary.Dataflow.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.

271

|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]]|MetadataflowReferenceType|[[Metadataflow>>doc:sdmx:Glossary.Metadataflow.WebHome]] provides a reference to a [[metadata flow>>doc:sdmx:Glossary.Metadataflow.WebHome]] in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields

272

|ReferencePeriod|ReferencePeriodType|ReferencePeriod provides an inclusive start and end date for the data or metadata being sought.

273

|DataKeySet|DataKeySetType|DataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.

274

|CubeRegion|CubeRegionType|CubeRegion is used to provide sets of include or excluded values for [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]] when querying for data.

275

|MetadataTargetRegion|MetadataTargetRegionType|MetadataTargetRegion is used to provide sets of included or excluded values for identifier [[components>>doc:sdmx:Glossary.Component.WebHome]] when querying for metadata.

276

277

**QueryRegistrationResponseType:** QueryRegistrationResponseType describes the structure of a registration query response. It provides a status for the request, and if successful, the resulting data and/or metadata results.

278

279

Content:

280

StatusMessage, QueryResult

281

282

Element Documentation:

283

284

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

285

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

286

|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.

287

|QueryResult|QueryResultType|QueryResult contains a result for a successful registration query. It can occur multiple times, for each registration the meets the conditions specified in the query.

288

289

**QueryResultType:** QueryResultType describes the structure of a query result for a single [[data source>>doc:sdmx:Glossary.Data source.WebHome]]. Either a data result or metadata result is detailed, depending on the [[data source>>doc:sdmx:Glossary.Data source.WebHome]].

Attributes:

timeSeriesMatch

Content:

(DataResult|MetadataResult)

296

297

Attribute Documentation:

298

299

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

300

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

301

|timeSeriesMatch|xs:boolean|(% style="width:793px" %)The timeSeriesMatch [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] is true when the result is an exact match with the key found in the registry - that is, when the registered [[data source>>doc:sdmx:Glossary.Data source.WebHome]] provides a matching key. It is set to false when the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is registered with cube-region (% style="color:#e74c3c" %)constraints(%%), or in any other circumstance when it cannot be established that the sought-for keys have been exactly matched. This is always true when the resulting [[data source>>doc:sdmx:Glossary.Data source.WebHome]] is the source of a [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]].

302

303

Element Documentation:

304

305

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

306

|(% style="width:159px" %)**Name**|(% style="width:211px" %)**Type**|(% style="width:336px" %)**Documentation**

307

|(% style="width:159px" %)DataResult|(% style="width:211px" %)ResultType|(% style="width:336px" %)

308

|(% style="width:159px" %)MetadataResult|(% style="width:211px" %)ResultType|(% style="width:336px" %)

**ResultType:**

ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content (% style="color:#e74c3c" %)constraints(%%) for the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] may be provided, if the query requested this information.

313

314

Content:

315

Registration, (% style="color:#e74c3c" %)Constraint

316

317

Element Documentation:

318

319

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

320

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

321

|Registration|RegistrationType|(% style="width:731px" %)Registration provides the details of a matching registration. In addition to the [[data source>>doc:sdmx:Glossary.Data source.WebHome]] and [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]] information, the id of the registration must also be provided.

322

|(%%)(% style="color:#e74c3c" %)Constraint|ConstraintReferenceType|(% style="width:731px" %)(% style="color:#e74c3c" %)Constraint(%%) provides a reference to a data or metadata (% style="color:#e74c3c" %)constraint(%%) in the registry for the resulting [[data source>>doc:sdmx:Glossary.Data source.WebHome]] (or possibly (% style="color:#e74c3c" %)constraints(%%) base on the registration [[provision agreement>>doc:sdmx:Glossary.Provision agreement.WebHome]], [[data provider>>doc:sdmx:Glossary.Data provider.WebHome]], structure usage, or structure). The reference is provided for by a URN and/or a complete set of reference fields.

323

324

**SubmitStructureRequestType:** SubmitStructureRequestType describes the structure of a structure submission. Structural [[components>>doc:sdmx:Glossary.Component.WebHome]] are provided either in-line or referenced via a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained [[components>>doc:sdmx:Glossary.Component.WebHome]], but can be overridden on a per [[component>>doc:sdmx:Glossary.Component.WebHome]] basis.

325

326

Attributes:

327

action?, externalDependencies?

328

329

Content:

330

(StructureLocation|Structures), SubmittedStructure

331

332

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

333

334

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

335

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

336

|action (default: Append)|ActionType|(% style="width:737px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the default action (append-add, replace-update, delete, or no action-informational) to be taken on all structural [[components>>doc:sdmx:Glossary.Component.WebHome]] in either the external [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message or the in-line [[components>>doc:sdmx:Glossary.Component.WebHome]]. The default action is Append. The Replace action is not applicable to final structures in the repository, and will produce an error condition, as these can be versioned but not modified. To submit a later (% style="color:#e74c3c" %)version(%%) of a structural object, the object should include the incremented (% style="color:#e74c3c" %)version(%%) number.

337

|externalDependencies (default: false)|xs:boolean|(% style="width:737px" %)The externalDependencies [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates the default resolution of external dependencies. This should be set to true if the repository is expected to use external reference URLs in the structural [[components>>doc:sdmx:Glossary.Component.WebHome]] to retrieve any externally referenced objects that is used by a non-external object.

338

339

Element Documentation:

340

341

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

342

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

343

|StructureLocation|xs:anyURI|(% style="width:734px" %)StructureLocation provides the location of a [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message, external to the repository that can be retrieved by the repository submission service.

344

|Structures|StructuresType|(% style="width:734px" %)Structures allows for the inline definition of structural [[components>>doc:sdmx:Glossary.Component.WebHome]] for submission.

345

|SubmittedStructure|SubmittedStructureType|(% style="width:734px" %)SubmittedStructure contains a reference to one of the structural [[maintainable artefacts>>doc:sdmx:Glossary.Maintainable artefact.WebHome]] detailed in the external [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure message or in-line and provides an override for the default action. This should only be used if the action to be performed on the referenced structural object is different than the default action. For example, one may want to append all structural [[components>>doc:sdmx:Glossary.Component.WebHome]] of a structure message, save one [[codelist>>doc:sdmx:Glossary.Code list.WebHome]]. This [[codelist>>doc:sdmx:Glossary.Code list.WebHome]] could be referenced in a submitted structure element and given an action of Informational.

346

347

**SubmittedStructureType:** SubmittedStructureType generally references a submitted structural object. When used in a submit structure request, its purpose is to override the default action or external dependency resolution behavior. If neither of these indicators are set, then it will be ignored. In a submit structure response, it is used to reference a submitted object for the purpose of providing a status for the submission. In this case, the action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be populated in order to echo the requested action.

348

349

Attributes:

350

action?, externalDependencies?

Content:

MaintainableObject

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

356

357

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

358

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

359

|action|ActionType|The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] will indicate the action to be taken on the referenced structural object. This should be provided when this structure is used in a submit structure response.

360

|externalDependencies|xs:boolean|The externalDependencies [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be set to true if the repository is expected to use external reference URLs in the structural [[components>>doc:sdmx:Glossary.Component.WebHome]] to retrieve objects on which the referenced object has dependencies. (Thus, if a data structure referenced here is being submitted to the repository, and the structure message has URLs which point to the locations of the [[codelists>>doc:sdmx:Glossary.Code list.WebHome]] it uses, then this [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] should be set to true). This should not be provided when this structure is used in a submit structure response.

361

362

Element Documentation:

363

364

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

365

|(% style="width:184px" %)**Name**|(% style="width:270px" %)**Type**|(% style="width:297px" %)**Documentation**

366

|(% style="width:184px" %)MaintainableObject|(% style="width:270px" %)MaintainableUrnReferenceType|(% style="width:297px" %)

367

368

**SubmitStructureResponseType:** SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.

Content:

SubmissionResult+

Element Documentation:

374

375

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

376

|(% style="width:156px" %)**Name**|(% style="width:222px" %)**Type**|(% style="width:539px" %)**Documentation**

377

|(% style="width:156px" %)SubmissionResult|(% style="width:222px" %)SubmissionResultType|(% style="width:539px" %)SubmissionResult provides a status for each submitted structural object.

378

379

**SubmissionResultType:** SubmissionResultType provides the status of the structural object submission request. It will identify the object submitted, report back the action requested, and convey the status and any error messages which are relevant to the submission.

380

381

Content:

382

SubmittedStructure, StatusMessage

383

384

Element Documentation:

385

386

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

387

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

388

|SubmittedStructure|(% style="width:201px" %)SubmittedStructureType|(% style="width:542px" %)SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.

389

|StatusMessage|(% style="width:201px" %)StatusMessageType|(% style="width:542px" %)StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.

390

391

**SubmitSubscriptionsRequestType:** SubmitSubscriptionsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]]. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] are submitted to the registry to subscribe to registration and change events for specific registry resources.

Content:

SubscriptionRequest+

Element Documentation:

397

398

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

399

|(% style="width:242px" %)**Name**|(% style="width:223px" %)**Type**|(% style="width:246px" %)**Documentation**

400

|(% style="width:242px" %)SubscriptionRequest|(% style="width:223px" %)SubscriptionRequestType|(% style="width:246px" %)

401

402

**SubscriptionType:** SubscriptionType describes the details of a subscription to a registration or change event for registry resources. When it occurs as the content of a response message, the registry URN must be provide, unless the response is a failure notification for the creation of a new subscription.

403

404

Content:

405

Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector

406

407

Element Documentation:

408

409

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

410

|Organisation|OrganisationReferenc eType|Organisation provides a reference to the organisation that owns this subscription. The reference is provided via a URN and/or a complete set of reference fields.|

411

|RegistryURN|xs:anyURI|RegistryURN is used to identify the subscription in the case of deletion or modification. This should be provided in all response messages, unless the response it a notification of the failure to create a newly submitted subscription - in which case there will be no registry assigned URN.|

412

|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single subscription.|

413

|NotificationHTTP|NotificationURLType|NotificationHTTP holds an http address to which notifications can be addressed as POSTs. Multiple http address may be notified for a single subscription event.|

414

|SubscriberAssignedID|IDType|SubscriberAssignedID allows the subscriber to specify an identification which will be returned as part of the notification for the subscribed events. This should be used if multiple new requests are made, so that the responses can be accurately correlated to the requests.|

415

|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the subscription.|

416

|EventSelector|EventSelectorType|EventSelector indicates an event or events for the subscription.|

417

418

**SubscriptionRequestType:** SubscriptionRequestType describes the structure of a single subscription request. It contains subscription details and an action field to indicate the action to be taken on the contained subscription. Note that if the action is update or delete, then the registry supplied URN for the subscription must be included.

Attributes:

action

Content:

Subscription

Attribute Documentation:

427

428

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

429

|action|ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.|

430

431

Element Documentation:

432

433

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

434

|Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.|

435

436

**SubmitSubscriptionsResponseType:** SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request.

Content:

SubscriptionStatus+

Element Documentation:

442

443

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

444

|SubscriptionStatus|SubscriptionStatusTy pe|SubscriptionStatus contains information which describes the success or failure of a subscription request, providing any error messages in the event of failure. The statuses should occur in the same order as the requests when responding to a message with multiple subscription requests. If a subscriber-assigned identification for the subscription is provided, it will be returned to allow for accurate matching of the responses to the requests. A registry assigned URN will be returned for any successfully created, updated, or deleted subscription.|

445

446

**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single subscription request.

447

448

Content:

449

SubscriptionURN?, SubscriberAssignedID?, StatusMessage

450

451

Element Documentation:

452

453

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

454

|SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.|

455

|SubscriberAssignedID|IDType|SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.|

456

|StatusMessage|StatusMessageType|StatusMessage provides that status for the subscription request, and if necessary, any error or warning information.|

457

458

**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.

Content:

Organisation

Element Documentation:

464

465

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

466

|Organisation|OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.|

467

468

**QuerySubscriptionResponseType:** QuerySubscriptionResponseType describes the structure of a subscription query response. A status will describe the success or failure of the request (and provide error or warning messages if necessary). If the query was successful, details of all of the organisation's subscriptions will be provided.

469

470

Content:

471

StatusMessage, Subscription

472

473

Element Documentation:

474

475

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

476

|StatusMessage|StatusMessageType|StatusMessage provides that status for the query subscription request, and if necessary, any error or warning information.|

477

|Subscription|SubscriptionType|Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.|

478

479

**NotifyRegistryEventType:** NotifyRegistryEventType describes the structure a registry notification, in response to a subscription to a registry event. At a minimum, the event time, a reference to the change object, a reference to the underlying subscription triggering the notification, and the action that took place on the object are sent. In addition, the full details of the object may be provided at the discretion of the registry. In the event that the details are not sent, it will be possible to query for the details of the changed object using the reference provided.

480

481

Content:

482

EventTime, (ObjectURN|RegistrationID), SubscriptionURN, EventAction, (StructuralEvent|RegistrationEvent)?

483

484

Element Documentation:

485

486

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

487

|EventTime|xs:dateTime|EventTime specifies the time of the triggering event.|

488

|ObjectURN|xs:anyURI|ObjectURN provides the URN of the object on which the event occurred, unless the event is related to a registration, in which case the RegistrationID element should be used.|

489

|RegistrationID|IDType|RegistrationID provides the id of the registration that underwent an event.|

490

|SubscriptionURN|xs:anyURI|SubscriptionURN provides the registry/repository URN of the subscription that is the cause of this notification being sent.|

491

|EventAction|ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.|

492

|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed.|

493

|RegistrationEvent|RegistrationEventTyp e|RegistrationEvent is used to provide the details or the registration object that has changed.|

494

495

**NotificationURLType:** NotificationURLType describes the structure of an http or email address. The content holds the addresses while an attribute indicates whether or not is expects the contents in a SOAP message.

Derivation:

xs:anySimpleType (restriction)

500

xs:anyURI (extension)

NotificationURLType

Attributes:

isSOAP?

Content:

Attribute Documentation:

508

509

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

510

|isSOAP (default: false)|xs:boolean|The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.|

511

512

**ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the subscription period.

Content:

StartDate, EndDate

Element Documentation:

518

519

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

520

|StartDate|xs:date|StartDate is an inclusive start date for the subscription.|

521

|EndDate|xs:date|EndDate is an inclusive end date for the subscription.|

522

523

**EventSelectorType:** EventSelectorType describes the details of the events for a subscription. It allows subscribers to specify registry and repository events for which they wish to receive notifications.

524

525

Content:

526

(StructuralRepositoryEvents|DataRegistrationEvents|MetadataRegistrationEvents)[1..3]

527

528

Element Documentation:

529

530

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

531

|StructuralRepository Events|StructuralRepository EventsType|StructuralRepositoryEvents details structural events for the subscription.|

532

|DataRegistrationEven ts|DataRegistrationEven tsType|DataRegistrationEvents details the data registration events for the subscription.|

533

|MetadataRegistration Events|MetadataRegistration EventsType|MetadataRegistrationEvents details the metadata registration events for the subscription.|

534

535

**StructuralRepositoryEventsType:** StructuralRepositoryEventsType details the structural events for the subscription. At least one maintenance agency must be specified, although it may be given a wildcard value (meaning the subscription is for the structural events of all agencies). This can also be a list of agencies to allow the subscription to subscribe the events of more than one agency. It should be noted that when doing so, all of the subsequent objects are assumed to apply to every agency in the list. The subscription is then refined by detailing the structural objects maintained by the agency for which the subscription should apply. It is possible to explicitly select all object events, all objects of given types, or to individually list out specific objects. Note that for any object, it is also possible to provide an explicit URN to reference a distinct object. In this case, the reference to maintenance agency described above is ignored. Although it is not required, if specific objects are being referenced by explicit URNs, it is good practice to list the agencies.

Attributes:

TYPE?

Content:

Attribute Documentation:

544

545

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

546

|TYPE (fixed: STRUCTURE)|xs:string|TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.|

547

548

Element Documentation:

549

550

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

551

|AgencyID|NestedIDQueryType|AgencyID specifies a maintenance agency for the object or objects indicated in the other fields. This can be either a specific ID, or a single wildcard character ("%"). A wild card character can be used to select all agencies, allowing a subscription to all events for particular object types. This can occur multiple times to list a of group of maintenance agencies, creating event subscriptions for all of the subsequent objects for each agency in the group. Note that if multiple agencies are supplied, then the wildcard character should not be used for any of them.|

552

|AllEvents|EmptyType|AllEvents creates a subscription to structural events for all structural objects maintained by the agencies referenced.|

553

|AgencyScheme|VersionableObjectEve ntType|AgencyScheme is used to subscribe to changes of agency schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

554

|DataConsmerScheme|VersionableObjectEve ntType|DataConsmerScheme is used to subscribe to changes of data consumer schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

555

|DataProviderScheme|VersionableObjectEve ntType|DataProviderScheme is used to subscribe to changes of data provider schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

556

|OrganisationUnitSche me|VersionableObjectEve ntType|OrganisationUnitScheme is used to subscribe to changes of organisation unit schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

557

|Dataflow|VersionableObjectEve ntType|Dataflow is used to subscribe to changes of data flows. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

558

|Metadataflow|VersionableObjectEve ntType|Metadataflow is used to subscribe to changes of metadata flows. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

559

|CategoryScheme|VersionableObjectEve ntType|CategoryScheme is used to subscribe to changes of category schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

560

|Categorisation|IdentifiableObjectEv entType|Categorisation is used to subscribe to changes of categorizations. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id field can be selected.|

561

|Codelist|VersionableObjectEve ntType|Codelist is used to subscribe to changes of code lists. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

562

|HierarchicalCodelist|VersionableObjectEve ntType|HierarchicalCodelist is used to subscribe to changes of hierarchical code lists. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

563

|ConceptScheme|VersionableObjectEve ntType|ConceptScheme is used to subscribe to changes of concept schemes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

564

|MetadataStructureDef inition|VersionableObjectEve ntType|MetadataStructureDefinition is used to subscribe to changes of metadata structure definitions. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

565

|KeyFamily|VersionableObjectEve ntType|KeyFamily is used to subscribe to changes of key families. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

566

|StructureSet|VersionableObjectEve ntType|StructureSet is used to subscribe to changes of structure sets. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

567

|ReportingTaxonomy|VersionableObjectEve ntType|ReportingTaxonomy is used to subscribe to changes of reporting taxonomies. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

568

|Process|VersionableObjectEve ntType|Process is used to subscribe to changes of processes. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

569

|AttachmentConstraint|VersionableObjectEve ntType|AttachmentConstraint is used to subscribe to changes of attachment constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

570

|ContentConstraint|VersionableObjectEve ntType|ContentConstraint is used to subscribe to changes of content constraints. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

571

|ProvisionAgreement|VersionableObjectEve ntType|ProvisionAgreement is used to subscribe to changes of a provision agreement. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

572

|TransformationScheme|VersionableObjectEve ntType|TransformationScheme is used to subscribe to changes of a transformation scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

573

|NameAliasScheme|VersionableObjectEve ntType|NameAliasScheme is used to subscribe to changes of a name alias scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

574

|NamePersonalisationS cheme|VersionableObjectEve ntType|NamePersonalisationScheme is used to subscribe to changes of a name peronsalisation scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

575

|RulesetScheme|VersionableObjectEve ntType|RulesetScheme is used to subscribe to changes of a ruleset scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

576

|UserDefinedOperatorS cheme|VersionableObjectEve ntType|UserDefinedOperatorScheme is used to subscribe to changes of a user defined operator scheme. The maintenance agencies of the object are those identified in the AgencyID collection, effectively making separate version of this query for each agency specified. The agency is ignored if the content of this is a URN, which references an explicit object. Otherwise, either all objects of this type or specific object according to the id and version fields can be selected.|

577

578

**IdentifiableObjectEventType:** IdentifiableObjectEventType describes the structure of a reference to an identifiable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.

Content:

(All|URN|ID)

Element Documentation:

584

585

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

586

|All|EmptyType|All subscribes to the events all instances of the containing object meeting the other criteria specified.|

587

|URN|xs:anyURI|URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.|

588

|ID|IDQueryType|ID subscribes to the events of the specific instance of the object type where the value provided here matches the id of the object. The default value is the wildcard character("%").|

589

590

**VersionableObjectEventType:** VersionableObjectEventType describes the structure of a reference to a versionable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.

591

592

Content:

593

(All|URN|(ID, Version))

594

595

Element Documentation:

596

597

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

598

|All|EmptyType|All subscribes to the events all instances of the containing object meeting the other criteria specified.|

599

|URN|xs:anyURI|URN subscribes to the events of the specific instance of the object type referenced by this URN. Note that when this field is used, the agency information inherited from the structural repository event container is ignored.|

600

|ID|IDQueryType|ID subscribes to the events of the specific instance of the object type where the value provided here matches the id of the object and the value provided in the version field matches the version of the object. The default value is the wildcard character("%").|

601

|Version|VersionQueryType|Version subscribes to the events of the specific instance of the object type where the value provided in the id field matches the id of the object and the value here matches the version of the object. The default value is the wildcard character("%"). Note that in addition to being wild-carded, this can also be bound to the latest version of the object with the late-bound character("\*").|

602

603

**DataRegistrationEventsType:** DataRegistrationEventsType details the data registration events for the subscription. It is possible to subscribe to all data registration events in the repository, or specific events for; single registrations, provision agreements, data providers, data flows, key families, and categories that categorize data flows or key families.

Attributes:

TYPE?

Content:

Attribute Documentation:

612

613

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

614

|TYPE (fixed: DATA)|xs:string|TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.|

615

616

Element Documentation:

617

618

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

619

|AllEvents|EmptyType|AllEvents subscribes to all data registration events in the repository.|

620

|RegistrationID|IDType|RegistrationID subscribes to all the data registration events for the unique registration referenced.|

621

|ProvisionAgreement|ProvisionAgreementRe ferenceType|ProvisionAgreementReference subscribes to all data registration events for the explicitly referenced provision agreement.|

622

|DataProvider|DataProviderReferenc eType|DataProviderReference subscribes to all data registration events for the explicitly referenced data provider.|

623

|DataflowReference|MaintainableEventTyp e|DataflowReference subscribes to all data registration events for the data flows referenced by this object. This may reference one or more data flows, as the specific references fields allow for a wild-carded value.|

624

|KeyFamilyReference|MaintainableEventTyp e|KeyFamilyReference subscribes to all data registration events for the key families referenced by this object. This may reference one or more key families, as the specific references fields allow for a wild-carded value.|

625

|Category|CategoryReferenceTyp e|Category subscribes to all data registration events for any data flows or key families that are categorized by the referenced category.|

626

627

**MetadataRegistrationEventsType:** MetadataRegistrationEventsType details the metadata registration events for the subscription. It is possible to subscribe to all metadata registration events in the repository, or specific events for; single registrations, provision agreements, data providers, metadata flows, metadata structure definitions, and categories that categorize metadata flows or metadata structure definitions.

Attributes:

TYPE?

Content:

Attribute Documentation:

636

637

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

638

|TYPE (fixed: METADATA)|xs:string|TYPE is a fixed attribute that is used to ensure only of each event selector may be provided, when it is referenced in a uniqueness constraint.|

639

640

Element Documentation:

641

642

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

643

|AllEvents|EmptyType|AllEvents subscribes to all metadata registration events in the repository.|

644

|RegistrationID|IDType|RegistrationID subscribes to all the metadata registration events for the unique registration referenced.|

645

|ProvisionAgreement|ProvisionAgreementRe ferenceType|ProvisionAgreementReference subscribes to all metadata registration events for the explicitly referenced provision agreement.|

646

|DataProvider|DataProviderReferenc eType|DataProvider subscribes to all metadata registration events for the explicitly referenced data provider.|

647

|MetadataflowReferenc e|MaintainableEventTyp e|MetadataflowReference subscribes to all metadata registration events for the metadata flows referenced by this object. This may reference one or more metadata flows, as the specific references fields allow for a wild-carded value.|

648

|MetadataStructureDef initionReference|MaintainableEventTyp e|MetadataStructureDefinitionReference subscribes to all metadata registration events for the metadata structure definitions referenced by this object. This may reference one or more metadata structure definitions, as the specific references fields allow for a wild-carded value.|

649

|Category|CategoryReferenceTyp e|Category subscribes to all metadata registration events for any metadata flows or metadata structure definitions that are categorized by the referenced category.|

650

651

**MaintainableEventType:** MaintainableEventType provides a reference to a maintainable object's event with either the URN of the specific object, or a set of potentially wild-carded reference fields.

Content:

(URN|Ref)

Element Documentation:

657

658

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

659

|URN|xs:anyURI|URN provides an explicit reference to a single object.|

660

|Ref|MaintainableQueryTyp e|Ref provides a reference to potentially many object through the use of possible wild-carded reference fields.|

661

662

**StructuralEventType:** StructuralEventType provides the details of a structure event, specifically the object that changed.

Content:

Structures

Element Documentation:

668

669

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

670

|Structures|StructuresType|Structures contains the details of the structural object that has triggered the event. Although this container allows for multiple structural object, it should only contain the one changed object.|

671

672

**RegistrationEventType:** This provides the details of a data or metadata registration event for the purposes of notification.

Content:

Registration

Element Documentation:

678

679

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

680

|Registration|RegistrationType|Registration provides the changed details of the data or metadata registration.|

681

682

=== 2.1.3 Simple Types ===

683

684

**IDQueryType:** IDQueryType is a simple type that allows for an identifier to be substituted with a wild card character ("%").

685

686

Union of:

687

IDType, WildCardValueType.

688

689

**NestedIDQueryType:** NestedIDQueryType is a simple type that allows for a nested identifier to be substituted with a wild card character ("%").

690

691

Union of:

692

NestedIDType, WildCardValueType.

693

694

**VersionQueryType:** VersionQueryType is a simple type that allows for a version number to be substituted with a wild card character ("%") or a late bound character ("\*").

695

696

Union of:

697

LegacyVersionNumberType, SemanticVersionNumberType, SemanticVersionReferenceType, WildcardType, WildCardValueType.

698

699

**StatusType:** StatusType provides an enumeration of values that detail the status of queries or requests.

700

701

Derived by restriction of xs:NMTOKEN.

702