Changes for page Part V. Registry Namespace
Last modified by Elena on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -281,11 +281,12 @@ 281 281 282 282 Element Documentation: 283 283 284 -|**Name**|**Type**|**Documentation**| 285 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the registration query request, and if necessary, any error or warning information.| 286 -|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.| 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. 287 287 288 -**QueryResultType:** QueryResultType describes the structure of a query result for a single data source. Either a data result or metadata result is detailed, depending on the data source. 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]]. 289 289 290 290 Attributes: 291 291 timeSeriesMatch ... ... @@ -295,27 +295,32 @@ 295 295 296 296 Attribute Documentation: 297 297 298 -|**Name**|**Type**|**Documentation**| 299 -|timeSeriesMatch|xs:boolean|The timeSeriesMatch attribute is true when the result is an exact match with the key found in the registry - that is, when the registered data source provides a matching key. It is set to false when the data source is registered with cube-region 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 is the source of a metadata set.| 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]]. 300 300 301 301 Element Documentation: 302 302 303 -|**Name**|**Type**|**Documentation**| 304 -|DataResult|ResultType| | 305 -|MetadataResult|ResultType| | 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" %) 306 306 307 -**ResultType:** ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content constraints for the data source may be provided, if the query requested this information.310 +**ResultType:** 308 308 312 +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 + 309 309 Content: 310 -Registration, Constraint 315 +Registration, (% style="color:#e74c3c" %)Constraint 311 311 312 312 Element Documentation: 313 313 314 -|**Name**|**Type**|**Documentation**| 315 -|Registration|RegistrationType|Registration provides the details of a matching registration. In addition to the data source and provision agreement information, the id of the registration must also be provided.| 316 -|Constraint|ConstraintReferenceT ype|Constraint provides a reference to a data or metadata constraint in the registry for the resulting data source (or possibly constraints base on the registration provision agreement, data provider, structure usage, or structure). The reference is provided for by a URN and/or a complete set of reference fields.| 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. 317 317 318 -**SubmitStructureRequestType:** SubmitStructureRequestType describes the structure of a structure submission. Structural components are provided either in-line or referenced via a SDMX-ML Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained components, but can be overridden on a per component basis. 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. 319 319 320 320 Attributes: 321 321 action?, externalDependencies? ... ... @@ -323,21 +323,22 @@ 323 323 Content: 324 324 (StructureLocation|Structures), SubmittedStructure 325 325 326 -Attribute Documentation: 332 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 327 327 328 -|**Name**|**Type**|**Documentation**| 329 -|action (default: Append)|ActionType|The action attribute indicates the default action (append-add, replace-update, delete, or no action-informational) to be taken on all structural components in either the external SDMX-ML Structure message or the in-line components. 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 version of a structural object, the object should include the incremented version number.| 330 -|externalDependencies (default: false)|xs:boolean|The externalDependencies attribute 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 to retrieve any externally referenced objects that is used by a non-external object.| 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. 331 331 332 332 Element Documentation: 333 333 334 - |**Name**|**Type**|**Documentation**|335 - 336 -|StructureLocation|xs:anyURI|StructureLocation provides the location of a SDMX-ML Structure message, external to the repository that can be retrieved by the repository submission service. |337 -|Structures|StructuresType|Structures allows for the inline definition of structural components for submission. |338 -|SubmittedStructure|SubmittedStructureTy |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. 339 339 340 -**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 should be populated in order to echo the requested action. 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. 341 341 342 342 Attributes: 343 343 action?, externalDependencies? ... ... @@ -345,16 +345,18 @@ 345 345 Content: 346 346 MaintainableObject 347 347 348 -Attribute Documentation: 355 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 349 349 350 -|**Name**|**Type**|**Documentation**| 351 -|action|ActionType|The action attribute 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.| 352 -|externalDependencies|xs:boolean|The externalDependencies attribute should be set to true if the repository is expected to use external reference URLs in the structural components 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 it uses, then this attribute should be set to true). This should not be provided when this structure is used in a submit structure response.| 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. 353 353 354 354 Element Documentation: 355 355 356 -|**Name**|**Type**|**Documentation**| 357 -|MaintainableObject|MaintainableUrnRefer enceType| | 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" %) 358 358 359 359 **SubmitStructureResponseType:** SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned. 360 360 ... ... @@ -363,8 +363,9 @@ 363 363 364 364 Element Documentation: 365 365 366 -|**Name**|**Type**|**Documentation**| 367 -|SubmissionResult|SubmissionResultType|SubmissionResult provides a status for each submitted structural object.| 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. 368 368 369 369 **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. 370 370 ... ... @@ -373,11 +373,12 @@ 373 373 374 374 Element Documentation: 375 375 376 -|**Name**|**Type**|**Documentation**| 377 -|SubmittedStructure|SubmittedStructureTy pe|SubmittedStructure provides a reference to the submitted structural object and echoes back the action requested for it.| 378 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the submission of the structural object, and if necessary, any error or warning information.| 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. 379 379 380 -**SubmitSubscriptionsRequestType:** SubmitSubscriptionsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of subscriptions. Subscriptions are submitted to the registry to subscribe to registration and change events for specific registry resources. 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. 381 381 382 382 Content: 383 383 SubscriptionRequest+ ... ... @@ -384,10 +384,11 @@ 384 384 385 385 Element Documentation: 386 386 387 -|**Name**|**Type**|**Documentation**| 388 -|SubscriptionRequest|SubscriptionRequestT ype| | 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" %) 389 389 390 -**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. 402 +**SubscriptionType:** SubscriptionType describes the details of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Notification.WebHome]] for the creation of a new [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 391 391 392 392 Content: 393 393 Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector ... ... @@ -394,34 +394,37 @@ 394 394 395 395 Element Documentation: 396 396 397 -|**Name**|**Type**|**Documentation**| 398 -|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.| 399 -|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.| 400 -|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single subscription.| 401 -|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.| 402 -|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.| 403 -|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the subscription.| 404 -|EventSelector|EventSelectorType|EventSelector indicates an event or events for the subscription.| 409 +(% style="width:1056.29px" %) 410 +|**Name**|**Type**|**Documentation** 411 +|Organisation|OrganisationReferenceType|Organisation provides a reference to the organisation that owns this [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. The reference is provided via a URN and/or a complete set of reference fields. 412 +|RegistryURN|xs:anyURI|RegistryURN is used to identify the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the case of deletion or modification. This should be provided in all response messages, unless the response it a [[notification>>doc:sdmx:Glossary.Notification.WebHome]] of the failure to create a newly submitted [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] - in which case there will be no registry assigned URN. 413 +|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 414 +|NotificationHTTP|NotificationURLType|NotificationHTTP holds an http address to which [[notifications>>doc:sdmx:Glossary.Notification.WebHome]] can be addressed as POSTs. Multiple http address may be notified for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] event. 415 +|SubscriberAssignedID|IDType|SubscriberAssignedID allows the subscriber to specify an identification which will be returned as part of the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] 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. 416 +|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 417 +|EventSelector|EventSelectorType|EventSelector indicates an event or events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 405 405 406 -**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. 419 +**SubscriptionRequestType:** SubscriptionRequestType describes the structure of a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request. It contains [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] details and an action field to indicate the action to be taken on the contained [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. Note that if the action is update or delete, then the registry supplied URN for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] must be included. 407 407 408 408 Attributes: 409 409 action 410 410 411 411 Content: 412 -Subscription 425 +[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 413 413 414 -Attribute Documentation: 427 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 415 415 416 -|**Name**|**Type**|**Documentation**| 417 -|action|ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.| 429 +(% style="width:1118.29px" %) 430 +|**Name**|**Type**|(% style="width:753px" %)**Documentation** 431 +|action|ActionType|(% style="width:753px" %)The action [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether this is an addition, a modification, or a deletion of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 418 418 419 419 Element Documentation: 420 420 421 -|**Name**|**Type**|**Documentation**| 422 -|Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.| 435 +(% style="width:1123.29px" %) 436 +|**Name**|**Type**|**Documentation** 437 +|[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|SubscriptionType|[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] contains the details of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to be added, updated, or deleted. 423 423 424 -**SubmitSubscriptionsResponseType:** SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request. 439 +**SubmitSubscriptionsResponseType:** SubmitSubscriptionsResponseType describes the structure of the response to a new [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] submission. A status is provided for each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] in the request. 425 425 426 426 Content: 427 427 SubscriptionStatus+ ... ... @@ -428,10 +428,11 @@ 428 428 429 429 Element Documentation: 430 430 431 -|**Name**|**Type**|**Documentation**| 432 -|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.| 446 +(% style="width:1129.29px" %) 447 +|**Name**|**Type**|**Documentation** 448 +|SubscriptionStatus|SubscriptionStatusType|SubscriptionStatus contains information which describes the success or failure of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]] requests. If a subscriber-assigned identification for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]]. 433 433 434 -**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single subscription request. 450 +**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request. 435 435 436 436 Content: 437 437 SubscriptionURN?, SubscriberAssignedID?, StatusMessage ... ... @@ -438,12 +438,13 @@ 438 438 439 439 Element Documentation: 440 440 441 -|**Name**|**Type**|**Documentation**| 442 -|SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.| 443 -|SubscriberAssignedID|IDType|SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.| 444 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the subscription request, and if necessary, any error or warning information.| 457 +(% style="width:1154.29px" %) 458 +|**Name**|**Type**|(% style="width:676px" %)**Documentation** 459 +|SubscriptionURN|xs:anyURI|(% style="width:676px" %)SubscriptionURN contains the registry generated URN for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and will be returned for any successfully created, updated, or deleted [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 460 +|SubscriberAssignedID|IDType|(% style="width:676px" %)SubscriberAssignedID is the id assigned by the subscriber to the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. If it existed in the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, it will be returned. 461 +|StatusMessage|StatusMessageType|(% style="width:676px" %)StatusMessage provides that status for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information. 445 445 446 -**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved. 463 +**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]]. [[Subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] for a given organisation may be retrieved. 447 447 448 448 Content: 449 449 Organisation ... ... @@ -450,10 +450,11 @@ 450 450 451 451 Element Documentation: 452 452 453 -|**Name**|**Type**|**Documentation**| 454 -|Organisation|OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.| 470 +(% style="width:1164.29px" %) 471 +|**Name**|**Type**|**Documentation** 472 +|Organisation|OrganisationReferenceType|Organisation provides a reference to the [[data consumer>>doc:sdmx:Glossary.Data consumer.WebHome]] for which the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] details should be returned. 455 455 456 -**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. 474 +**QuerySubscriptionResponseType:** QuerySubscriptionResponseType describes the structure of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]] will be provided. 457 457 458 458 Content: 459 459 StatusMessage, Subscription ... ... @@ -460,11 +460,12 @@ 460 460 461 461 Element Documentation: 462 462 463 -|**Name**|**Type**|**Documentation**| 464 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the query subscription request, and if necessary, any error or warning information.| 465 -|Subscription|SubscriptionType|Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.| 481 +(% style="width:1199.29px" %) 482 +|**Name**|**Type**|(% style="width:683px" %)**Documentation** 483 +|StatusMessage|StatusMessageType|(% style="width:683px" %)StatusMessage provides that status for the query [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information. 484 +|[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]|SubscriptionType|(% style="width:683px" %)[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]] contains the details of a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] for the organisation. This may occur multiple times for each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 466 466 467 -**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. 486 +**NotifyRegistryEventType:** NotifyRegistryEventType describes the structure a registry [[notification>>doc:sdmx:Glossary.Notification.WebHome]], in response to a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] to a registry event. At a minimum, the event time, a reference to the change object, a reference to the underlying [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] triggering the [[notification>>doc:sdmx:Glossary.Notification.WebHome]], 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. 468 468 469 469 Content: 470 470 EventTime, (ObjectURN|RegistrationID), SubscriptionURN, EventAction, (StructuralEvent|RegistrationEvent)? ... ... @@ -471,16 +471,17 @@ 471 471 472 472 Element Documentation: 473 473 474 -|**Name**|**Type**|**Documentation**| 475 -|EventTime|xs:dateTime|EventTime specifies the time of the triggering event.| 476 -|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.| 477 -|RegistrationID|IDType|RegistrationID provides the id of the registration that underwent an event.| 478 -|SubscriptionURN|xs:anyURI|SubscriptionURN provides the registry/repository URN of the subscription that is the cause of this notification being sent.| 479 -|EventAction|ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.| 480 -|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed.| 481 -|RegistrationEvent|RegistrationEventTyp e|RegistrationEvent is used to provide the details or the registration object that has changed.| 493 +(% style="width:1213.29px" %) 494 +|**Name**|**Type**|**Documentation** 495 +|EventTime|xs:dateTime|EventTime specifies the time of the triggering event. 496 +|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. 497 +|RegistrationID|IDType|RegistrationID provides the id of the registration that underwent an event. 498 +|SubscriptionURN|xs:anyURI|SubscriptionURN provides the registry/repository URN of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] that is the cause of this [[notification>>doc:sdmx:Glossary.Notification.WebHome]] being sent. 499 +|EventAction|ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion. 500 +|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed. 501 +|RegistrationEvent|RegistrationEventType|RegistrationEvent is used to provide the details or the registration object that has changed. 482 482 483 -**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. 503 +**NotificationURLType:** NotificationURLType describes the structure of an http or email address. The content holds the addresses while an [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] indicates whether or not is expects the contents in a SOAP message. 484 484 485 485 Derivation: 486 486 ... ... @@ -492,12 +492,13 @@ 492 492 isSOAP? 493 493 494 494 Content: 495 -Attribute Documentation: 515 +[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation: 496 496 497 -|**Name**|**Type**|**Documentation**| 498 -|isSOAP (default: false)|xs:boolean|The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.| 517 +(% style="width:1068.29px" %) 518 +|**Name**|**Type**|**Documentation** 519 +|isSOAP (default:false)|xs:boolean|The isSOAP [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]], if true, indicates the provided URL expects the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] to be sent in a SOAP message. 499 499 500 -**ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the subscription period. 521 +**ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] period. 501 501 502 502 Content: 503 503 StartDate, EndDate ... ... @@ -504,23 +504,26 @@ 504 504 505 505 Element Documentation: 506 506 507 -|**Name**|**Type**|**Documentation**| 508 -|StartDate|xs:date|StartDate is an inclusive start date for the subscription.| 509 -|EndDate|xs:date|EndDate is an inclusive end date for the subscription.| 528 +(% style="width:1052.29px" %) 529 +|**Name**|**Type**|**Documentation** 530 +|StartDate|xs:date|StartDate is an inclusive start date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 531 +|EndDate|xs:date|EndDate is an inclusive end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 510 510 511 -**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. 533 +**EventSelectorType:** EventSelectorType describes the details of the events for a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. It allows subscribers to specify registry and repository events for which they wish to receive notifications. 512 512 513 513 Content: 536 + 514 514 (StructuralRepositoryEvents|DataRegistrationEvents|MetadataRegistrationEvents)[1..3] 515 515 516 516 Element Documentation: 517 517 518 -|**Name**|**Type**|**Documentation**| 519 -|StructuralRepository Events|StructuralRepository EventsType|StructuralRepositoryEvents details structural events for the subscription.| 520 -|DataRegistrationEven ts|DataRegistrationEven tsType|DataRegistrationEvents details the data registration events for the subscription.| 521 -|MetadataRegistration Events|MetadataRegistration EventsType|MetadataRegistrationEvents details the metadata registration events for the subscription.| 541 +(% style="width:1053.29px" %) 542 +|(% style="width:275px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:495px" %)**Documentation** 543 +|(% style="width:275px" %)StructuralRepositoryEvents|(% style="width:281px" %)StructuralRepositoryEventsType|(% style="width:495px" %)StructuralRepositoryEvents details structural events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 544 +|(% style="width:275px" %)DataRegistrationEvents|(% style="width:281px" %)DataRegistrationEventsType|(% style="width:495px" %)DataRegistrationEvents details the data registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 545 +|(% style="width:275px" %)MetadataRegistration Events|(% style="width:281px" %)MetadataRegistrationEventsType|(% style="width:495px" %)MetadataRegistrationEvents details the metadata registration events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. 522 522 523 -**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. 547 +**StructuralRepositoryEventsType:** StructuralRepositoryEventsType details the structural events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]]. At least one [[maintenance agency>>doc:sdmx:Glossary.Maintenance agency.WebHome]] must be specified, although it may be given a wildcard value (meaning the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] is for the structural events of all agencies). This can also be a list of agencies to allow the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Subscription.WebHome]] is then refined by detailing the structural objects maintained by the agency for which the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] 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>>doc:sdmx:Glossary.Maintenance agency.WebHome]] 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. 524 524 525 525 Attributes: 526 526 TYPE?