Changes for page Part I. Message Namespace

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

From 3.3 to 3.4 From 3.13 to 3.14

From version 3.4

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

Change comment: There is no comment for this version

To version 3.13

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

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -264,17 +264,18 @@
  Element Documentation:
--|**Name**|**Type**|**Documentation**
--|Header|StructureSpecificTim eSeriesDataHeaderTyp e|
--|DataSet|//dsd: TimeSeriesDataSetTyp e//|
--|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
++(% style="width:839.294px" %)
++|**Name**|(% style="width:256px" %)**Type**|(% style="width:434px" %)**Documentation**
++|Header|(% style="width:256px" %)StructureSpecificTim eSeriesDataHeaderTyp e|(% style="width:434px" %)
++|DataSet|(% style="width:256px" %)//dsd: TimeSeriesDataSetTyp e//|(% style="width:434px" %)
++|ftr:Footer|(% style="width:256px" %)ftr:FooterType|(% style="width:434px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
  **GenericMetadataType: **GenericMetadataType defines the contents of a generic metadata message.
  Derivation:
--//MessageType// (restriction)
-- [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericMetadataType
++* //MessageType// (restriction)
++** GenericMetadataType
  Content:
@@ -282,17 +282,18 @@
  Element Documentation:
--|**Name**|**Type**|**Documentation**
--|Header|GenericMetadataHeade rType|
--|MetadataSet|rep:MetadataSetType|
--|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
++(% style="width:836.294px" %)
++|(% style="width:181px" %)**Name**|(% style="width:225px" %)**Type**|(% style="width:427px" %)**Documentation**
++|(% style="width:181px" %)Header|(% style="width:225px" %)GenericMetadataHeade rType|(% style="width:427px" %)
++|(% style="width:181px" %)MetadataSet|(% style="width:225px" %)rep:MetadataSetType|(% style="width:427px" %)
++|(% style="width:181px" %)ftr:Footer|(% style="width:225px" %)ftr:FooterType|(% style="width:427px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
  **StructureSpecificMetadataType: **StructureSpecificMetadataType defines the structure of a structure specific metadata message. Note that the metadata set payload type is abstract, and therefore it will have to be assigned a type in an instance. This type must be derived from the base type referenced. This base type defines a general structure which can be followed to allow for generic processing of the data even if the exact details of the data structure specific format are not known.
  Derivation:
--//MessageType// (restriction)
-- [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificMetadataType
++* //MessageType// (restriction)
++** StructureSpecificMetadataType
  Content:
@@ -300,17 +300,18 @@
  Element Documentation:
--|**Name**|**Type**|**Documentation**
--|Header|StructureSpecificMet adataHeaderType|
--|MetadataSet|//msd:MetadataSetType//|
--|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
++(% style="width:841.294px" %)
++|(% style="width:160px" %)**Name**|(% style="width:250px" %)**Type**|(% style="width:428px" %)**Documentation**
++|(% style="width:160px" %)Header|(% style="width:250px" %)StructureSpecificMet adataHeaderType|(% style="width:428px" %)
++|(% style="width:160px" %)MetadataSet|(% style="width:250px" %)//msd:MetadataSetType//|(% style="width:428px" %)
++|(% style="width:160px" %)ftr:Footer|(% style="width:250px" %)ftr:FooterType|(% style="width:428px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
  **RegistryInterfaceType: **This is a type which describes a structure for holding all of the various dedicated registry interface message types.
  Derivation:
--//MessageType// (restriction)
-- [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType
++* //MessageType// (restriction)
++** RegistryInterfaceType
  Content:
@@ -318,83 +318,84 @@
  Element Documentation:
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
--|SubmitRegistrationsR esponse|ref: SubmitRegistrationsR esponseType|SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.
--|QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.
--|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.
--|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.
--|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.
--|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.
--|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.
--|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
--|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.
--|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.
--|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
++(% style="width:903.294px" %)
++|**Name**|**Type**|(% style="width:441px" %)**Documentation**
++|Header|BasicHeaderType|(% style="width:441px" %)
++|SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|(% style="width:441px" %)SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
++|SubmitRegistrationsR esponse|ref: SubmitRegistrationsR esponseType|(% style="width:441px" %)SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.
++|QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|(% style="width:441px" %)QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.
++|QueryRegistrationRes ponse|ref: QueryRegistrationRes ponseType|(% style="width:441px" %)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.
++|SubmitStructureReque st|ref: SubmitStructureReque stType|(% style="width:441px" %)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.
++|SubmitStructureRespo nse|ref: SubmitStructureRespo nseType|(% style="width:441px" %)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.
++|SubmitSubscriptionsR equest|ref: SubmitSubscriptionsR equestType|(% style="width:441px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
++|SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|(% style="width:441px" %)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.
++|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|(% style="width:441px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
++|QuerySubscriptionRes ponse|ref: QuerySubscriptionRes ponseType|(% style="width:441px" %)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.
++|NotifyRegistryEvent|ref: NotifyRegistryEventT ype|(% style="width:441px" %)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.
++|ftr:Footer|ftr:FooterType|(% style="width:441px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
  **SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the structure of a registry submit registration requests 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="-"]] SubmitRegistrationsRequestType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** SubmitRegistrationsRequestType
  Content:
--Header, SubmitRegistrationsRequest
++* Header, SubmitRegistrationsRequest
++* Element Documentation:
--Element Documentation:
++(% style="width:844.294px" %)
++|**Name**|**Type**|(% style="width:377px" %)**Documentation**
++|Header|BasicHeaderType|(% style="width:377px" %)
++|SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|(% style="width:377px" %)SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|SubmitRegistrationsR equest|ref: SubmitRegistrationsR equestType|SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a data set or metadata set. The data source to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
--
  **SubmitRegistrationsResponseType: **SubmitRegistrationsResponseType 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="-"]] SubmitRegistrationsResponseType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** SubmitRegistrationsResponseType
  Content:
--Header, SubmitRegistrationsResponse, ftr:Footer?
++* Header, SubmitRegistrationsResponse, ftr:Footer?
++* Element Documentation:
--Element Documentation:
++(% style="width:847.294px" %)
++|**Name**|(% style="width:210px" %)**Type**|(% style="width:408px" %)**Documentation**
++|Header|(% style="width:210px" %)BasicHeaderType|(% style="width:408px" %)
++|SubmitRegistrationsR esponse|(% style="width:210px" %)ref: SubmitRegistrationsR esponseType|(% style="width:408px" %)SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.
++|ftr:Footer|(% style="width:210px" %)ftr:FooterType|(% style="width:408px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|SubmitRegistrationsR esponse|ref: SubmitRegistrationsR esponseType|SubmitRegistrationsResponse is sent to the agency or data/metadata provider in response to a submit registrations request. It indicates the success or failure of each registration request, and contains any error messages generated by the registration service.
--|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
--
  **QueryRegistrationRequestType: **QueryRegistrationRequestType defines the structure of a registry query registration 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="-"]] QueryRegistrationRequestType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** QueryRegistrationRequestType
  Content:
--Header, QueryRegistrationRequest
++* Header, QueryRegistrationRequest
++* Element Documentation:
--Element Documentation:
++(% style="width:847.294px" %)
++|**Name**|**Type**|(% style="width:397px" %)**Documentation**
++|Header|BasicHeaderType|(% style="width:397px" %)
++|QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|(% style="width:397px" %)QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.
--|**Name**|**Type**|**Documentation**
--|Header|BasicHeaderType|
--|QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|QueryRegistrationRequest is used to query the contents of a registry for data sets and metadata sets. It specifies whether the result set should include metadata sets, data sets, or both. The search can be characterized by providing constraints including reference periods, data regions, and data keys.
--
  **QueryRegistrationResponseType: **SubmitRegistrationRequestType 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="-"]] QueryRegistrationResponseType
++* //MessageType// (restriction)
++** RegistryInterfaceType (restriction)
++*** QueryRegistrationResponseType
  Content:
@@ -402,18 +402,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:
@@ -421,43 +421,43 @@
  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:
--
  |**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.