Skip to Content
Last modified by Elena on 2025/09/10 11:19
From version 3.14
edited by Helena
on 2025/07/02 17:11
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

Summary

Details

Page properties
Content
... ... @@ -399,7 +399,7 @@
399 399  |(% style="width:242px" %)**Name**|(% style="width:223px" %)**Type**|(% style="width:246px" %)**Documentation**
400 400  |(% style="width:242px" %)SubscriptionRequest|(% style="width:223px" %)SubscriptionRequestType|(% style="width:246px" %)
401 401  
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]].
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 403  
404 404  Content:
405 405  Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector
... ... @@ -406,37 +406,34 @@
406 406  
407 407  Element Documentation:
408 408  
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]].
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.|
418 418  
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.
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.
420 420  
421 421  Attributes:
422 422  action
423 423  
424 424  Content:
425 -[[Subscription>>doc:sdmx:Glossary.Subscription.WebHome]]
424 +Subscription
426 426  
427 -[[Attribute>>doc:sdmx:Glossary.Attribute.WebHome]] Documentation:
426 +Attribute Documentation:
428 428  
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]].
428 +|**Name**|**Type**|**Documentation**|
429 +|action|ActionType|The action attribute indicates whether this is an addition, a modification, or a deletion of a subscription.|
432 432  
433 433  Element Documentation:
434 434  
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.
433 +|**Name**|**Type**|**Documentation**|
434 +|Subscription|SubscriptionType|Subscription contains the details of the subscription to be added, updated, or deleted.|
438 438  
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.
436 +**SubmitSubscriptionsResponseType:** SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request.
440 440  
441 441  Content:
442 442  SubscriptionStatus+
... ... @@ -443,11 +443,10 @@
443 443  
444 444  Element Documentation:
445 445  
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]].
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.|
449 449  
450 -**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request.
446 +**SubscriptionStatusType:** SubscriptionStatusType describes the structure a status for a single subscription request.
451 451  
452 452  Content:
453 453  SubscriptionURN?, SubscriberAssignedID?, StatusMessage
... ... @@ -455,11 +455,11 @@
455 455  Element Documentation:
456 456  
457 457  |**Name**|**Type**|**Documentation**|
458 -|SubscriptionURN|xs:anyURI|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]].|
459 -|SubscriberAssignedID|IDType|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.|
460 -|StatusMessage|StatusMessageType|StatusMessage provides that status for the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, and if necessary, any error or warning information.|
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.|
461 461  
462 -**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.
458 +**QuerySubscriptionRequestType:** QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.
463 463  
464 464  Content:
465 465  Organisation
... ... @@ -467,9 +467,9 @@
467 467  Element Documentation:
468 468  
469 469  |**Name**|**Type**|**Documentation**|
470 -|Organisation|OrganisationReferenc eType|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.|
466 +|Organisation|OrganisationReferenc eType|Organisation provides a reference to the data consumer for which the subscription details should be returned.|
471 471  
472 -**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.
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.
473 473  
474 474  Content:
475 475  StatusMessage, Subscription