Changes for page Part I. Message Namespace

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

From version 3.3
edited by Helena
on 2025/06/23 17:03
Change comment: There is no comment for this version
To version 3.9
edited by Helena
on 2025/06/23 17:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -225,17 +225,18 @@
225 225  
226 226  Element Documentation:
227 227  
228 -|**Name**|(% style="width:248px" %)**Type**|(% style="width:1671px" %)**Documentation**
229 -|Header|(% style="width:248px" %)GenericTimeSeriesDat aHeaderType|(% style="width:1671px" %)
230 -|DataSet|(% style="width:248px" %)dat: TimeSeriesDataSetTyp e|(% style="width:1671px" %)
231 -|ftr:Footer|(% style="width:248px" %)ftr:FooterType|(% style="width:1671px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
228 +(% style="width:856.294px" %)
229 +|**Name**|(% style="width:239px" %)**Type**|(% style="width:458px" %)**Documentation**
230 +|Header|(% style="width:239px" %)GenericTimeSeriesDat aHeaderType|(% style="width:458px" %)
231 +|DataSet|(% style="width:239px" %)dat: TimeSeriesDataSetTyp e|(% style="width:458px" %)
232 +|ftr:Footer|(% style="width:239px" %)ftr:FooterType|(% style="width:458px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
232 232  
233 233  **StructureSpecificDataType: **StructureSpecificDataType defines the structure of the structure specific data message. Note that the data 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.
234 234  
235 235  Derivation:
236 236  
237 -//MessageType// (restriction)
238 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificDataType
238 +* //MessageType// (restriction)
239 +** StructureSpecificDataType
239 239  
240 240  Content:
241 241  
... ... @@ -243,18 +243,19 @@
243 243  
244 244  Element Documentation:
245 245  
246 -|**Name**|**Type**|**Documentation**
247 -|Header|StructureSpecificDat aHeaderType|
248 -|DataSet|//dsd:DataSetType//|
249 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
247 +(% style="width:828.294px" %)
248 +|**Name**|(% style="width:247px" %)**Type**|(% style="width:420px" %)**Documentation**
249 +|Header|(% style="width:247px" %)StructureSpecificDat aHeaderType|(% style="width:420px" %)
250 +|DataSet|(% style="width:247px" %)//dsd:DataSetType//|(% style="width:420px" %)
251 +|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.
250 250  
251 251  **StructureSpecificTimeSeriesDataType: **StructureSpecificTimeSeriesDataType defines the structure of the structure specific time series data message.
252 252  
253 253  Derivation:
254 254  
255 -//MessageType// (restriction)
256 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificDataType (restriction)
257 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificTimeSeriesDataType
257 +* //MessageType// (restriction)
258 +** StructureSpecificDataType (restriction)
259 +*** StructureSpecificTimeSeriesDataType
258 258  
259 259  Content:
260 260  
... ... @@ -262,17 +262,18 @@
262 262  
263 263  Element Documentation:
264 264  
265 -|**Name**|**Type**|**Documentation**
266 -|Header|StructureSpecificTim eSeriesDataHeaderTyp e|
267 -|DataSet|//dsd: TimeSeriesDataSetTyp e//|
268 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
267 +(% style="width:839.294px" %)
268 +|**Name**|(% style="width:256px" %)**Type**|(% style="width:434px" %)**Documentation**
269 +|Header|(% style="width:256px" %)StructureSpecificTim eSeriesDataHeaderTyp e|(% style="width:434px" %)
270 +|DataSet|(% style="width:256px" %)//dsd: TimeSeriesDataSetTyp e//|(% style="width:434px" %)
271 +|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.
269 269  
270 270  **GenericMetadataType: **GenericMetadataType defines the contents of a generic metadata message.
271 271  
272 272  Derivation:
273 273  
274 -//MessageType// (restriction)
275 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] GenericMetadataType
277 +* //MessageType// (restriction)
278 +** GenericMetadataType
276 276  
277 277  Content:
278 278  
... ... @@ -280,17 +280,18 @@
280 280  
281 281  Element Documentation:
282 282  
283 -|**Name**|**Type**|**Documentation**
284 -|Header|GenericMetadataHeade rType|
285 -|MetadataSet|rep:MetadataSetType|
286 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
286 +(% style="width:836.294px" %)
287 +|(% style="width:181px" %)**Name**|(% style="width:225px" %)**Type**|(% style="width:427px" %)**Documentation**
288 +|(% style="width:181px" %)Header|(% style="width:225px" %)GenericMetadataHeade rType|(% style="width:427px" %)
289 +|(% style="width:181px" %)MetadataSet|(% style="width:225px" %)rep:MetadataSetType|(% style="width:427px" %)
290 +|(% 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.
287 287  
288 288  **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.
289 289  
290 290  Derivation:
291 291  
292 -//MessageType// (restriction)
293 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] StructureSpecificMetadataType
296 +* //MessageType// (restriction)
297 +** StructureSpecificMetadataType
294 294  
295 295  Content:
296 296  
... ... @@ -298,17 +298,18 @@
298 298  
299 299  Element Documentation:
300 300  
301 -|**Name**|**Type**|**Documentation**
302 -|Header|StructureSpecificMet adataHeaderType|
303 -|MetadataSet|//msd:MetadataSetType//|
304 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
305 +(% style="width:841.294px" %)
306 +|(% style="width:160px" %)**Name**|(% style="width:250px" %)**Type**|(% style="width:428px" %)**Documentation**
307 +|(% style="width:160px" %)Header|(% style="width:250px" %)StructureSpecificMet adataHeaderType|(% style="width:428px" %)
308 +|(% style="width:160px" %)MetadataSet|(% style="width:250px" %)//msd:MetadataSetType//|(% style="width:428px" %)
309 +|(% 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.
305 305  
306 306  **RegistryInterfaceType: **This is a type which describes a structure for holding all of the various dedicated registry interface message types.
307 307  
308 308  Derivation:
309 309  
310 -//MessageType// (restriction)
311 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType
315 +* //MessageType// (restriction)
316 +** RegistryInterfaceType
312 312  
313 313  Content:
314 314  
... ... @@ -316,46 +316,47 @@
316 316  
317 317  Element Documentation:
318 318  
319 -|**Name**|**Type**|**Documentation**
320 -|Header|BasicHeaderType|
321 -|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.
322 -|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.
323 -|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.
324 -|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.
325 -|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.
326 -|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.
327 -|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.
328 -|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.
329 -|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
330 -|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.
331 -|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.
332 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
324 +(% style="width:903.294px" %)
325 +|**Name**|**Type**|(% style="width:441px" %)**Documentation**
326 +|Header|BasicHeaderType|(% style="width:441px" %)
327 +|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.
328 +|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.
329 +|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.
330 +|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.
331 +|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.
332 +|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.
333 +|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.
334 +|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.
335 +|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|(% style="width:441px" %)QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
336 +|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.
337 +|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.
338 +|ftr:Footer|ftr:FooterType|(% style="width:441px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
333 333  
334 334  **SubmitRegistrationsRequestType: **SubmitRegistrationsRequestType defines the structure of a registry submit registration requests document.
335 335  
336 336  Derivation:
337 337  
338 -//MessageType// (restriction)
339 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
340 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitRegistrationsRequestType
344 +* //MessageType// (restriction)
345 +** RegistryInterfaceType (restriction)
346 +*** SubmitRegistrationsRequestType
341 341  
342 342  Content:
343 343  
344 -Header, SubmitRegistrationsRequest
350 +* Header, SubmitRegistrationsRequest
351 +* Element Documentation:
345 345  
346 -Element Documentation:
353 +(% style="width:844.294px" %)
354 +|**Name**|**Type**|(% style="width:377px" %)**Documentation**
355 +|Header|BasicHeaderType|(% style="width:377px" %)
356 +|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.
347 347  
348 -|**Name**|**Type**|**Documentation**
349 -|Header|BasicHeaderType|
350 -|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.
351 -
352 352  **SubmitRegistrationsResponseType: **SubmitRegistrationsResponseType defines the structure of a registry submit registration response document.
353 353  
354 354  Derivation:
355 355  
356 -//MessageType// (restriction)
357 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
358 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitRegistrationsResponseType
362 +* //MessageType// (restriction)
363 +** RegistryInterfaceType (restriction)
364 +*** SubmitRegistrationsResponseType
359 359  
360 360  Content:
361 361