Skip to Content

Changes for page Part I. Message Namespace

Last modified by Artur on 2025/09/10 11:19
From version 7.4
edited by Helena
on 2025/06/30 22:38
Change comment: There is no comment for this version
To version 7.1
edited by Helena
on 2025/06/29 16:17
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -42,10 +42,10 @@
42 42  |(% style="width:612px" %)**Namespace**|(% style="width:173px" %)**Prefix**
43 43  |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/common|(% style="width:173px" %)com
44 44  |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/generic|(% style="width:173px" %)dat
45 -|(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific|(% style="width:173px" %)dsd
45 +|(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/data/structurespecific|(% style="width:173px" %)[[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]
46 46  |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/message/footer|(% style="width:173px" %)ftr
47 47  |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/generic|(% style="width:173px" %)rep
48 -|(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific|(% style="width:173px" %)msd
48 +|(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/metadata/structurespecific|(% style="width:173px" %)[[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]
49 49  |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/query|(% style="width:173px" %)qry
50 50  |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/registry|(% style="width:173px" %)ref
51 51  |(% style="width:612px" %)http:~/~/www.sdmx.org/resources/sdmxml/schemas/v2_1/structure|(% style="width:173px" %)str
... ... @@ -52,6 +52,7 @@
52 52  |(% style="width:612px" %)http:~/~/www.w3.org/2001/XMLSchema|(% style="width:173px" %)xs
53 53  
54 54  Contents:
55 +
55 55  50 Global Elements
56 56  62 Complex Types
57 57  1 Simple Type
... ... @@ -168,10 +168,9 @@
168 168  
169 169  Element Documentation:
170 170  
171 -(% style="width:1004.83px" %)
172 -|**Name**|**Type**|(% style="width:631px" %)**Documentation**
173 -|Header|//BaseHeaderType//|(% style="width:631px" %)
174 -|ftr:Footer|ftr:FooterType|(% style="width:631px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
172 +|**Name**|**Type**|**Documentation**
173 +|Header|//BaseHeaderType//|
174 +|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
175 175  
176 176  **StructureType: **StructureType defines the contents of a structure message. The payload is optional since this message may be returned from a web service with only information in the footer.
177 177  
... ... @@ -243,7 +243,7 @@
243 243  (% style="width:828.294px" %)
244 244  |**Name**|(% style="width:247px" %)**Type**|(% style="width:420px" %)**Documentation**
245 245  |Header|(% style="width:247px" %)StructureSpecificDat aHeaderType|(% style="width:420px" %)
246 -|[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:247px" %)//dsd:DataSetType//|(% style="width:420px" %)
246 +|[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:247px" %)//[[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]:DataSetType//|(% style="width:420px" %)
247 247  |ftr:Footer|(% style="width:247px" %)ftr:FooterType|(% style="width:420px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
248 248  
249 249  **StructureSpecificTimeSeriesDataType: **StructureSpecificTimeSeriesDataType defines the structure of the structure specific time series data message.
... ... @@ -262,7 +262,7 @@
262 262  (% style="width:839.294px" %)
263 263  |**Name**|(% style="width:256px" %)**Type**|(% style="width:434px" %)**Documentation**
264 264  |Header|(% style="width:256px" %)StructureSpecificTim eSeriesDataHeaderTyp e|(% style="width:434px" %)
265 -|[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:256px" %)//dsd: TimeSeriesDataSetTyp e//|(% style="width:434px" %)
265 +|[[DataSet>>doc:sdmx:Glossary.Data set.WebHome]]|(% style="width:256px" %)//[[dsd>>doc:sdmx:Glossary.Data structure definition.WebHome]]: TimeSeriesDataSetTyp e//|(% style="width:434px" %)
266 266  |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.
267 267  
268 268  **GenericMetadataType: **GenericMetadataType defines the contents of a generic metadata message.
... ... @@ -279,7 +279,7 @@
279 279  
280 280  (% style="width:836.294px" %)
281 281  |(% style="width:181px" %)**Name**|(% style="width:225px" %)**Type**|(% style="width:427px" %)**Documentation**
282 -|(% style="width:181px" %)Header|(% style="width:225px" %)GenericMetadataHeaderType|(% style="width:427px" %)
282 +|(% style="width:181px" %)Header|(% style="width:225px" %)GenericMetadataHeade rType|(% style="width:427px" %)
283 283  |(% style="width:181px" %)MetadataSet|(% style="width:225px" %)rep:MetadataSetType|(% style="width:427px" %)
284 284  |(% 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.
285 285  
... ... @@ -297,8 +297,8 @@
297 297  
298 298  (% style="width:841.294px" %)
299 299  |(% style="width:160px" %)**Name**|(% style="width:250px" %)**Type**|(% style="width:428px" %)**Documentation**
300 -|(% style="width:160px" %)Header|(% style="width:250px" %)StructureSpecificMetadataHeaderType|(% style="width:428px" %)
301 -|(% style="width:160px" %)MetadataSet|(% style="width:250px" %)//msd:MetadataSetType//|(% style="width:428px" %)
300 +|(% style="width:160px" %)Header|(% style="width:250px" %)StructureSpecificMet adataHeaderType|(% style="width:428px" %)
301 +|(% style="width:160px" %)MetadataSet|(% style="width:250px" %)//[[msd>>doc:sdmx:Glossary.Metadata structure definition.WebHome]]:MetadataSetType//|(% style="width:428px" %)
302 302  |(% 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.
303 303  
304 304  **RegistryInterfaceType: **This is a type which describes a structure for holding all of the various dedicated registry interface message types.
... ... @@ -313,21 +313,21 @@
313 313  
314 314  Element Documentation:
315 315  
316 -(% style="width:1000.83px" %)
317 -|**Name**|(% style="width:317px" %)**Type**|(% style="width:491px" %)**Documentation**
318 -|Header|(% style="width:317px" %)BasicHeaderType|(% style="width:491px" %)
319 -|SubmitRegistrationsRequest|(% style="width:317px" %)ref: SubmitRegistrationsRequestType|(% style="width:491px" %)SubmitRegistrationsRequest is sent to the registry by an agency or data/metadata provider to request one or more registrations for a [[data set>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. The [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
320 -|SubmitRegistrationsResponse|(% style="width:317px" %)ref: SubmitRegistrationsResponseType|(% style="width:491px" %)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.
321 -|QueryRegistrationRequest|(% style="width:317px" %)ref: QueryRegistrationRequestType|(% style="width:491px" %)QueryRegistrationRequest is used to query the contents of a registry for [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] and [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]]. It specifies whether the result set should include [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]], [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], or both. The search can be characterized by providing (% style="color:#e74c3c" %)constraints(%%) including [[reference periods>>doc:sdmx:Glossary.Reference period.WebHome]], data regions, and data keys.
322 -|QueryRegistrationResponse|(% style="width:317px" %)ref: QueryRegistrationResponseType|(% style="width:491px" %)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.
323 -|SubmitStructureReque st|(% style="width:317px" %)ref: SubmitStructureReque stType|(% style="width:491px" %)SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, (% style="color:#e74c3c" %)concepts(%%) and [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], etc.) to be submitted may be communicated in-line or be supplied in a referenced [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure messages external to the registry. A response will indicate status and contain any relevant error information.
324 -|SubmitStructureRespo nse|(% style="width:317px" %)ref: SubmitStructureRespo nseType|(% style="width:491px" %)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.
325 -|SubmitSubscriptionsR equest|(% style="width:317px" %)ref: SubmitSubscriptionsR equestType|(% style="width:491px" %)SubmitSubscriptionsRequest contains one or more requests submitted to the registry to subscribe to registration and change events for specific registry resources.
326 -|SubmitSubscriptionsR esponse|(% style="width:317px" %)ref: SubmitSubscriptionsR esponseType|(% style="width:491px" %)SubmitSubscriptionsResponse is the response to a submit [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] request. It contains information which describes the success or failure of each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, providing any error messages in the event of failure. If successful, it returns the registry URN of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and the subscriber-assigned ID.
327 -|QuerySubscriptionReq uest|(% style="width:317px" %)ref: QuerySubscriptionReq uestType|(% style="width:491px" %)QuerySubscriptionRequest is used to query the registry for the [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] of a given organisation.
328 -|QuerySubscriptionRes ponse|(% style="width:317px" %)ref: QuerySubscriptionRes ponseType|(% style="width:491px" %)QuerySubscriptionResponse is sent as a response to a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] query. If the query is successful, the details of all [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] for the requested organisation are sent.
329 -|NotifyRegistryEvent|(% style="width:317px" %)ref: NotifyRegistryEventT ype|(% style="width:491px" %)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>>doc:sdmx:Glossary.Subscription.WebHome]] that triggered the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] are always sent. Optionally, the details of the changed object may also be provided.
330 -|ftr:Footer|(% style="width:317px" %)ftr:FooterType|(% style="width:491px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
316 +(% style="width:903.294px" %)
317 +|**Name**|**Type**|(% style="width:441px" %)**Documentation**
318 +|Header|BasicHeaderType|(% style="width:441px" %)
319 +|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>>doc:sdmx:Glossary.Data set.WebHome]] or [[metadata set>>doc:sdmx:Glossary.Metadata set.WebHome]]. The [[data source>>doc:sdmx:Glossary.Data source.WebHome]] to be registered must be accessible to the registry services at an indicated URL, so that it can be processed by those services.
320 +|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.
321 +|QueryRegistrationReq uest|ref: QueryRegistrationReq uestType|(% style="width:441px" %)QueryRegistrationRequest is used to query the contents of a registry for [[data sets>>doc:sdmx:Glossary.Data set.WebHome]] and [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]]. It specifies whether the result set should include [[metadata sets>>doc:sdmx:Glossary.Metadata set.WebHome]], [[data sets>>doc:sdmx:Glossary.Data set.WebHome]], or both. The search can be characterized by providing (% style="color:#e74c3c" %)constraints(%%) including [[reference periods>>doc:sdmx:Glossary.Reference period.WebHome]], data regions, and data keys.
322 +|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.
323 +|SubmitStructureReque st|ref: SubmitStructureReque stType|(% style="width:441px" %)SubmitStructureRequest is used to submit structure definitions to the repository. The structure resources (key families, agencies, (% style="color:#e74c3c" %)concepts(%%) and [[concept schemes>>doc:sdmx:Glossary.Concept scheme.WebHome]], [[code lists>>doc:sdmx:Glossary.Code list.WebHome]], etc.) to be submitted may be communicated in-line or be supplied in a referenced [[SDMX-ML>>doc:sdmx:Glossary.SDMX-ML.WebHome]] Structure messages external to the registry. A response will indicate status and contain any relevant error information.
324 +|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.
325 +|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.
326 +|SubmitSubscriptionsR esponse|ref: SubmitSubscriptionsR esponseType|(% style="width:441px" %)SubmitSubscriptionsResponse is the response to a submit [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] request. It contains information which describes the success or failure of each [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] request, providing any error messages in the event of failure. If successful, it returns the registry URN of the [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]], and the subscriber-assigned ID.
327 +|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|(% style="width:441px" %)QuerySubscriptionRequest is used to query the registry for the [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] of a given organisation.
328 +|QuerySubscriptionRes ponse|ref: QuerySubscriptionRes ponseType|(% style="width:441px" %)QuerySubscriptionResponse is sent as a response to a [[subscription>>doc:sdmx:Glossary.Subscription.WebHome]] query. If the query is successful, the details of all [[subscriptions>>doc:sdmx:Glossary.Subscription.WebHome]] for the requested organisation are sent.
329 +|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>>doc:sdmx:Glossary.Subscription.WebHome]] that triggered the [[notification>>doc:sdmx:Glossary.Notification.WebHome]] are always sent. Optionally, the details of the changed object may also be provided.
330 +|ftr:Footer|ftr:FooterType|(% style="width:441px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
331 331  
332 332  **SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the structure of a registry submit registration requests document.
333 333