Changes for page Part I. Message Namespace

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

From 3.10 to 3.11 From 3.17 to 3.18

From version 3.11

edited by Helena
on 2025/06/23 17:08

Change comment: There is no comment for this version

To version 3.17

edited by Helena
on 2025/06/23 17:13

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -406,18 +406,19 @@
  Element Documentation:
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|QueryRegistrationRes ponse|ref: QueryRegistrationRes ponseType|QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.
--|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
++(% style="width:856.294px" %)
++|**Name**|(% style="width:235px" %)**Type**|(% style="width:407px" %)**Documentation**
++|Header|(% style="width:235px" %)BasicHeaderType|(% style="width:407px" %)
++|QueryRegistrationRes ponse|(% style="width:235px" %)ref: QueryRegistrationRes ponseType|(% style="width:407px" %)QueryRegistrationResponse is sent as a response to any query of the contents of a registry. The result set contains a set of links to data and/or metadata If the result set is null, or there is some other problem with the query, then appropriate error messages and statuses will be returned.
++|ftr:Footer|(% style="width:235px" %)ftr:FooterType|(% style="width:407px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
  **SubmitStructureRequestType: **SubmitStructureRequestType defines the structure of a registry submit structure request document.
  Derivation:
--//MessageType// (restriction)
-- [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
--       [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitStructureRequestType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** SubmitStructureRequestType
  Content:
@@ -425,152 +425,152 @@
  Element Documentation:
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|SubmitStructureReque st|ref: SubmitStructureReque stType|SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.
++(% style="width:870.294px" %)
++|**Name**|**Type**|(% style="width:453px" %)**Documentation**
++|Header|BasicHeaderType|(% style="width:453px" %)
++|SubmitStructureReque st|ref: SubmitStructureReque stType|(% style="width:453px" %)SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, concepts and concept schemes, code lists, etc.) to be submitted may be communicated in-line or be supplied in a referenced SDMX-ML Structure messages external to the registry. A response will indicate status and contain any relevant error information.
  **SubmitStructureResponseType: **SubmitStructureResponseType defines the structure of a registry submit registration response document.
  Derivation:
--//MessageType// (restriction)
-- [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
--       [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitStructureResponseType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** SubmitStructureResponseType
  Content:
--Header, SubmitStructureResponse, ftr:Footer?
++* Header, SubmitStructureResponse, ftr:Footer?
++* Element Documentation:
--Element Documentation:
++(% style="width:835.294px" %)
++|**Name**|(% style="width:246px" %)**Type**|(% style="width:366px" %)**Documentation**
++|Header|(% style="width:246px" %)BasicHeaderType|(% style="width:366px" %)
++|SubmitStructureRespo nse|(% style="width:246px" %)ref: SubmitStructureRespo nseType|(% style="width:366px" %)SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.
++|ftr:Footer|(% style="width:246px" %)ftr:FooterType|(% style="width:366px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|SubmitStructureRespo nse|ref: SubmitStructureRespo nseType|SubmitStructureResponse is returned by the registry when a structure submission request is received. It indicates the status of the submission, and carries any error messages which are generated, if relevant.
--|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
--
  **SubmitSubscriptionsRequestType: **SubmitSubscriptionsRequestType defines the structure of a registry submit subscription request document.
  Derivation:
--//MessageType// (restriction)
-- [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
--       [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitSubscriptionsRequestType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** SubmitSubscriptionsRequestType
  Content:
--Header, SubmitSubscriptionsRequest
++* Header, SubmitSubscriptionsRequest
++* Element Documentation:
--Element Documentation:
++(% style="width:832.294px" %)
++|**Name**|(% style="width:227px" %)**Type**|(% style="width:319px" %)**Documentation**
++|Header|(% style="width:227px" %)BasicHeaderType|(% style="width:319px" %)
++|SubmitSubscriptionsR equest|(% style="width:227px" %)ref: SubmitSubscriptionsR equestType|(% style="width:319px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|SubmitSubscriptionsR equest|ref: SubmitSubscriptionsR equestType|SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
--
  **SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType defines the structure of a registry submit subscription response document.
  Derivation:
--//MessageType// (restriction)
-- [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
--       [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitSubscriptionsResponseType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** SubmitSubscriptionsResponseType
  Content:
--Header, SubmitSubscriptionsResponse, ftr:Footer?
++* Header, SubmitSubscriptionsResponse, ftr:Footer?
++* Element Documentation:
--Element Documentation:
++(% style="width:843.294px" %)
++|**Name**|**Type**|(% style="width:362px" %)**Documentation**
++|Header|BasicHeaderType|(% style="width:362px" %)
++|SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|(% style="width:362px" %)SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.
++|ftr:Footer|ftr:FooterType|(% style="width:362px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|SubmitSubscriptionsResponse is the response to a submit subscriptions request. It contains information which describes the success or failure of each subscription request, providing any error messages in the event of failure. If successful, it returns the registry URN of the subscription, and the subscriber-assigned ID.
--|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
--
  **QuerySubscriptionRequestType: **QuerySubscriptionRequestType defines the structure of a registry query subscription request document.
  Derivation:
--//MessageType// (restriction)
-- [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
--       [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QuerySubscriptionRequestType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** QuerySubscriptionRequestType
  Content:
--Header, QuerySubscriptionRequest
++* Header, QuerySubscriptionRequest
++* Element Documentation:
--Element Documentation:
++(% style="width:839.294px" %)
++|(% style="width:230px" %)**Name**|(% style="width:254px" %)**Type**|(% style="width:352px" %)**Documentation**
++|(% style="width:230px" %)Header|(% style="width:254px" %)BasicHeaderType|(% style="width:352px" %)
++|(% style="width:230px" %)QuerySubscriptionReq uest|(% style="width:254px" %)ref: QuerySubscriptionReq uestType|(% style="width:352px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
--
  **QuerySubscriptionResponseType: **QuerySubscriptionResponseType defines the structure of a registry query subscription response document.
  Derivation:
--//MessageType// (restriction)
-- [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
--       [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QuerySubscriptionResponseType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** QuerySubscriptionResponseType
  Content:
--Header, QuerySubscriptionResponse, ftr:Footer?
++* Header, QuerySubscriptionResponse, ftr:Footer?
++* Element Documentation:
--Element Documentation:
++(% style="width:912.294px" %)
++|**Name**|(% style="width:304px" %)**Type**|(% style="width:336px" %)**Documentation**
++|Header|(% style="width:304px" %)BasicHeaderType|(% style="width:336px" %)
++|QuerySubscriptionRes ponse|(% style="width:304px" %)ref: QuerySubscriptionRes ponseType|(% style="width:336px" %)QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.
++|ftr:Footer|(% style="width:304px" %)ftr:FooterType|(% style="width:336px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|QuerySubscriptionRes ponse|ref: QuerySubscriptionRes ponseType|QuerySubscriptionResponse is sent as a response to a subscription query. If the query is successful, the details of all subscriptions for the requested organisation are sent.
--|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
--
  **NotifyRegistryEventType: **NotifyRegistryEventType defines the structure of a registry notification document.
  Derivation:
--//MessageType// (restriction)
--   RegistryInterfaceType (restriction)
--         NotifyRegistryEventType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** NotifyRegistryEventType
  Content:
--Header, NotifyRegistryEvent
++* Header, NotifyRegistryEvent
++* Element Documentation:
--Element Documentation:
++(% style="width:836.294px" %)
++|**Name**|**Type**|(% style="width:473px" %)**Documentation**
++|Header|BasicHeaderType|(% style="width:473px" %)
++|NotifyRegistryEvent|ref: NotifyRegistryEventT ype|(% style="width:473px" %)NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|NotifyRegistryEvent|ref: NotifyRegistryEventT ype|NotifyRegistryEvent is sent by the registry services to subscribers, to notify them of specific registration and change events. Basic information about the event, such as the object that triggered it, the time of the event, the action that took place, and the subscription that triggered the notification are always sent. Optionally, the details of the changed object may also be provided.
--
  **DataQueryType: **DataQueryType defines the structure of a data query message.
  Derivation:
--//MessageType// (restriction)
--   DataQueryType
++* //MessageType// (restriction)
++** DataQueryType
  Content:
--Header, Query
++* Header, Query
++* Element Documentation:
--Element Documentation:
++(% style="width:839.294px" %)
++|(% style="width:244px" %)**Name**|(% style="width:262px" %)**Type**|(% style="width:330px" %)**Documentation**
++|(% style="width:244px" %)Header|(% style="width:262px" %)BasicHeaderType|(% style="width:330px" %)
++|(% style="width:244px" %)Query|(% style="width:262px" %)qry:DataQueryType|(% style="width:330px" %)
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|Query|qry:DataQueryType|
--
  **GenericDataQueryType: **DataQueryType defines the structure of a generic data query message.
  Derivation:
--//MessageType// (restriction)
--   DataQueryType (restriction)
--         GenericDataQueryType
++* //MessageType// (restriction)
++** DataQueryType (restriction)
++*** GenericDataQueryType
  Content:
--Header, Query
++* Header, Query
++* Element Documentation:
--Element Documentation:
--
  |**Name**|**Type**|**Documentation**
  |Header|BasicHeaderType|
  |Query|qry: GenericDataQueryType|