Changes for page Part V. Registry Namespace

Last modified by Elena on 2025/09/10 11:19

From 3.12 to 3.11 From 3.16 to 3.15

From version 3.15

edited by Helena
on 2025/07/02 17:14

Change comment: There is no comment for this version

To version 3.12

edited by Helena
on 2025/07/02 17:09

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -399,7 +399,7 @@
  |(% style="width:242px" %)**Name**|(% style="width:223px" %)**Type**|(% style="width:246px" %)**Documentation**
  |(% style="width:242px" %)SubscriptionRequest|(% style="width:223px" %)SubscriptionRequestType|(% style="width:246px" %)
--**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]].
++**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.
  Content:
  Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector
@@ -406,37 +406,34 @@
  Element Documentation:
--(% style="width:1056.29px" %)
--|**Name**|**Type**|**Documentation**
--|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.
--|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.
--|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]].
--|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.
--|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.
--|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
--|EventSelector|EventSelectorType|EventSelector indicates an event or events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
++|**Name**|**Type**|**Documentation**|
++|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.|
++|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.|
++|NotificationMailTo|NotificationURLType|NotificationMailTo holds an e-mail address (the "mailto~:" protocol). Multiple email address can be notified for a single subscription.|
++|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.|
++|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.|
++|ValidityPeriod|ValidityPeriodType|Validity period sets a start and end date for the subscription.|
++|EventSelector|EventSelectorType|EventSelector indicates an event or events for the subscription.|
--**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.
++**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>>doc:sdmx:Glossary.Subscription.WebHome]]
++Subscription
--[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
++Attribute Documentation:
--(% style="width:1118.29px" %)
--|**Name**|**Type**|(% style="width:753px" %)**Documentation**
--|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]].
++|**Name**|**Type**|**Documentation**|
++|action|ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.|
  Element Documentation:
--(% style="width:1123.29px" %)
--|**Name**|**Type**|**Documentation**
--|[[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.
++|**Name**|**Type**|**Documentation**|
++|Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.|
--**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.
++**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+
@@ -443,11 +443,10 @@
  Element Documentation:
--(% style="width:1129.29px" %)
--|**Name**|**Type**|**Documentation**
--|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]].
++|**Name**|**Type**|**Documentation**|
++|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.|
--**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request.
++**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single subscription request.
  Content:
  SubscriptionURN?, SubscriberAssignedID?, StatusMessage
@@ -454,13 +454,12 @@
  Element Documentation:
--(% style="width:1154.29px" %)
--|**Name**|**Type**|(% style="width:676px" %)**Documentation**
--|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]].
--|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.
--|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.
++|**Name**|**Type**|**Documentation**|
++|SubscriptionURN|xs:anyURI|SubscriptionURN contains the registry generated URN for the subscription, and will be returned for any successfully created, updated, or deleted subscription.|
++|SubscriberAssignedID|IDType|SubscriberAssignedID is the id assigned by the subscriber to the subscription. If it existed in the subscription request, it will be returned.|
++|StatusMessage|StatusMessageType|StatusMessage provides that status for the subscription request, and if necessary, any error or warning information.|
--**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.
++**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.
  Content:
  Organisation
@@ -467,11 +467,10 @@
  Element Documentation:
--(% style="width:1164.29px" %)
--|**Name**|**Type**|**Documentation**
--|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.
++|**Name**|**Type**|**Documentation**|
++|Organisation|OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.|
--**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.
++**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.
  Content:
  StatusMessage, Subscription
@@ -478,12 +478,11 @@
  Element Documentation:
--(% style="width:1199.29px" %)
--|**Name**|**Type**|(% style="width:683px" %)**Documentation**
--|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.
--|[[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]].
++|**Name**|**Type**|**Documentation**|
++|StatusMessage|StatusMessageType|StatusMessage provides that status for the query subscription request, and if necessary, any error or warning information.|
++|Subscription|SubscriptionType|Subscription contains the details of a subscription for the organisation. This may occur multiple times for each subscription.|
--**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.
++**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.
  Content:
  EventTime, (ObjectURN|RegistrationID), SubscriptionURN, EventAction, (StructuralEvent|RegistrationEvent)?
@@ -490,17 +490,16 @@
  Element Documentation:
--(% style="width:1213.29px" %)
--|**Name**|**Type**|**Documentation**
--|EventTime|xs:dateTime|EventTime specifies the time of the triggering event.
--|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.
--|RegistrationID|IDType|RegistrationID provides the id of the registration that underwent an event.
--|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.
--|EventAction|ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.
--|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed.
--|RegistrationEvent|RegistrationEventType|RegistrationEvent is used to provide the details or the registration object that has changed.
++|**Name**|**Type**|**Documentation**|
++|EventTime|xs:dateTime|EventTime specifies the time of the triggering event.|
++|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.|
++|RegistrationID|IDType|RegistrationID provides the id of the registration that underwent an event.|
++|SubscriptionURN|xs:anyURI|SubscriptionURN provides the registry/repository URN of the subscription that is the cause of this notification being sent.|
++|EventAction|ActionType|EventAction indicates the nature of the event - whether the action was an addition, a modification, or a deletion.|
++|StructuralEvent|StructuralEventType|StructuralEvent is used to provide the details of the structural object that has changed.|
++|RegistrationEvent|RegistrationEventTyp e|RegistrationEvent is used to provide the details or the registration object that has changed.|
--**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.
++**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:
@@ -512,13 +512,12 @@
  isSOAP?
  Content:
--[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
++Attribute Documentation:
--(% style="width:1068.29px" %)
--|**Name**|**Type**|**Documentation**
--|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.
++|**Name**|**Type**|**Documentation**|
++|isSOAP (default: false)|xs:boolean|The isSOAP attribute, if true, indicates the provided URL expects the notification to be sent in a SOAP message.|
--**ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] period.
++**ValidityPeriodType:** ValidityPeriodType specifies inclusive start and end-dates for the subscription period.
  Content:
  StartDate, EndDate
@@ -525,26 +525,23 @@
  Element Documentation:
--(% style="width:1052.29px" %)
--|**Name**|**Type**|**Documentation**
--|StartDate|xs:date|StartDate is an inclusive start date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
--|EndDate|xs:date|EndDate is an inclusive end date for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
++|**Name**|**Type**|**Documentation**|
++|StartDate|xs:date|StartDate is an inclusive start date for the subscription.|
++|EndDate|xs:date|EndDate is an inclusive end date for the subscription.|
--**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.
++**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.
  Content:
--
  (StructuralRepositoryEvents|DataRegistrationEvents|MetadataRegistrationEvents)[1..3]
  Element Documentation:
--(% style="width:1053.29px" %)
--|(% style="width:275px" %)**Name**|(% style="width:281px" %)**Type**|(% style="width:495px" %)**Documentation**
--|(% style="width:275px" %)StructuralRepositoryEvents|(% style="width:281px" %)StructuralRepositoryEventsType|(% style="width:495px" %)StructuralRepositoryEvents details structural events for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]].
--|(% 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]].
--|(% 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]].
++|**Name**|**Type**|**Documentation**|
++|StructuralRepository Events|StructuralRepository EventsType|StructuralRepositoryEvents details structural events for the subscription.|
++|DataRegistrationEven ts|DataRegistrationEven tsType|DataRegistrationEvents details the data registration events for the subscription.|
++|MetadataRegistration Events|MetadataRegistration EventsType|MetadataRegistrationEvents details the metadata registration events for the subscription.|
--**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.
++**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?