Changes for page Part I. Message Namespace

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

From version 3.7
edited by Helena
on 2025/06/23 17:06
Change comment: There is no comment for this version
To version 3.14
edited by Helena
on 2025/06/23 17:11
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -347,58 +347,58 @@
347 347  
348 348  Content:
349 349  
350 -Header, SubmitRegistrationsRequest
350 +* Header, SubmitRegistrationsRequest
351 +* Element Documentation:
351 351  
352 -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.
353 353  
354 -|**Name**|**Type**|**Documentation**
355 -|Header|BasicHeaderType|
356 -|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.
357 -
358 358  **SubmitRegistrationsResponseType: **SubmitRegistrationsResponseType defines the structure of a registry submit registration response document.
359 359  
360 360  Derivation:
361 361  
362 -//MessageType// (restriction)
363 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
364 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitRegistrationsResponseType
362 +* //MessageType// (restriction)
363 +** RegistryInterfaceType (restriction)
364 +*** SubmitRegistrationsResponseType
365 365  
366 366  Content:
367 367  
368 -Header, SubmitRegistrationsResponse, ftr:Footer?
368 +* Header, SubmitRegistrationsResponse, ftr:Footer?
369 +* Element Documentation:
369 369  
370 -Element Documentation:
371 +(% style="width:847.294px" %)
372 +|**Name**|(% style="width:210px" %)**Type**|(% style="width:408px" %)**Documentation**
373 +|Header|(% style="width:210px" %)BasicHeaderType|(% style="width:408px" %)
374 +|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.
375 +|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.
371 371  
372 -|**Name**|**Type**|**Documentation**
373 -|Header|BasicHeaderType|
374 -|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.
375 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
376 -
377 377  **QueryRegistrationRequestType: **QueryRegistrationRequestType defines the structure of a registry query registration request document.
378 378  
379 379  Derivation:
380 380  
381 -//MessageType// (restriction)
382 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
383 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QueryRegistrationRequestType
381 +* //MessageType// (restriction)
382 +** RegistryInterfaceType (restriction)
383 +*** QueryRegistrationRequestType
384 384  
385 385  Content:
386 386  
387 -Header, QueryRegistrationRequest
387 +* Header, QueryRegistrationRequest
388 +* Element Documentation:
388 388  
389 -Element Documentation:
390 +(% style="width:847.294px" %)
391 +|**Name**|**Type**|(% style="width:397px" %)**Documentation**
392 +|Header|BasicHeaderType|(% style="width:397px" %)
393 +|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.
390 390  
391 -|**Name**|**Type**|**Documentation**
392 -|Header|BasicHeaderType|
393 -|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.
394 -
395 395  **QueryRegistrationResponseType: **SubmitRegistrationRequestType defines the structure of a registry submit registration response document.
396 396  
397 397  Derivation:
398 398  
399 -//MessageType// (restriction)
400 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
401 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QueryRegistrationResponseType
399 +* //MessageType// (restriction)
400 +** RegistryInterfaceType (restriction)
401 +*** QueryRegistrationResponseType
402 402  
403 403  Content:
404 404  
... ... @@ -406,18 +406,19 @@
406 406  
407 407  Element Documentation:
408 408  
409 -|**Name**|**Type**|**Documentation**
410 -|Header|BasicHeaderType|
411 -|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.
412 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
409 +(% style="width:856.294px" %)
410 +|**Name**|(% style="width:235px" %)**Type**|(% style="width:407px" %)**Documentation**
411 +|Header|(% style="width:235px" %)BasicHeaderType|(% style="width:407px" %)
412 +|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.
413 +|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.
413 413  
414 414  **SubmitStructureRequestType: **SubmitStructureRequestType defines the structure of a registry submit structure request document.
415 415  
416 416  Derivation:
417 417  
418 -//MessageType// (restriction)
419 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
420 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitStructureRequestType
419 +* //MessageType// (restriction)
420 +** RegistryInterfaceType (restriction)
421 +*** SubmitStructureRequestType
421 421  
422 422  Content:
423 423  
... ... @@ -425,61 +425,61 @@
425 425  
426 426  Element Documentation:
427 427  
428 -|**Name**|**Type**|**Documentation**
429 -|Header|BasicHeaderType|
430 -|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.
429 +(% style="width:870.294px" %)
430 +|**Name**|**Type**|(% style="width:453px" %)**Documentation**
431 +|Header|BasicHeaderType|(% style="width:453px" %)
432 +|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.
431 431  
432 432  **SubmitStructureResponseType: **SubmitStructureResponseType defines the structure of a registry submit registration response document.
433 433  
434 434  Derivation:
435 435  
436 -//MessageType// (restriction)
437 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
438 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitStructureResponseType
438 +* //MessageType// (restriction)
439 +** RegistryInterfaceType (restriction)
440 +*** SubmitStructureResponseType
439 439  
440 440  Content:
441 441  
442 -Header, SubmitStructureResponse, ftr:Footer?
444 +* Header, SubmitStructureResponse, ftr:Footer?
445 +* Element Documentation:
443 443  
444 -Element Documentation:
447 +(% style="width:835.294px" %)
448 +|**Name**|(% style="width:246px" %)**Type**|(% style="width:366px" %)**Documentation**
449 +|Header|(% style="width:246px" %)BasicHeaderType|(% style="width:366px" %)
450 +|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.
451 +|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.
445 445  
446 -|**Name**|**Type**|**Documentation**
447 -|Header|BasicHeaderType|
448 -|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.
449 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
450 -
451 451  **SubmitSubscriptionsRequestType: **SubmitSubscriptionsRequestType defines the structure of a registry submit subscription request document.
452 452  
453 453  Derivation:
454 454  
455 -//MessageType// (restriction)
456 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
457 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitSubscriptionsRequestType
457 +* //MessageType// (restriction)
458 +** RegistryInterfaceType (restriction)
459 +*** SubmitSubscriptionsRequestType
458 458  
459 459  Content:
460 460  
461 -Header, SubmitSubscriptionsRequest
463 +* Header, SubmitSubscriptionsRequest
464 +* Element Documentation:
462 462  
463 -Element Documentation:
466 +(% style="width:832.294px" %)
467 +|**Name**|(% style="width:227px" %)**Type**|(% style="width:319px" %)**Documentation**
468 +|Header|(% style="width:227px" %)BasicHeaderType|(% style="width:319px" %)
469 +|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.
464 464  
465 -|**Name**|**Type**|**Documentation**
466 -|Header|BasicHeaderType|
467 -|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.
468 -
469 469  **SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType defines the structure of a registry submit subscription response document.
470 470  
471 471  Derivation:
472 472  
473 -//MessageType// (restriction)
474 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
475 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] SubmitSubscriptionsResponseType
475 +* //MessageType// (restriction)
476 +** RegistryInterfaceType (restriction)
477 +*** SubmitSubscriptionsResponseType
476 476  
477 477  Content:
478 478  
479 -Header, SubmitSubscriptionsResponse, ftr:Footer?
481 +* Header, SubmitSubscriptionsResponse, ftr:Footer?
482 +* Element Documentation:
480 480  
481 -Element Documentation:
482 -
483 483  |**Name**|**Type**|**Documentation**
484 484  |Header|BasicHeaderType|
485 485  |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.