Changes for page Part I. Message Namespace

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

From version 3.17
edited by Helena
on 2025/06/23 17:13
Change comment: There is no comment for this version
To version 3.7
edited by Helena
on 2025/06/23 17:06
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
351 -* Element Documentation:
350 +Header, SubmitRegistrationsRequest
352 352  
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.
352 +Element Documentation:
357 357  
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 -** RegistryInterfaceType (restriction)
364 -*** SubmitRegistrationsResponseType
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
365 365  
366 366  Content:
367 367  
368 -* Header, SubmitRegistrationsResponse, ftr:Footer?
369 -* Element Documentation:
368 +Header, SubmitRegistrationsResponse, ftr:Footer?
370 370  
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.
370 +Element Documentation:
376 376  
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 -** RegistryInterfaceType (restriction)
383 -*** QueryRegistrationRequestType
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
384 384  
385 385  Content:
386 386  
387 -* Header, QueryRegistrationRequest
388 -* Element Documentation:
387 +Header, QueryRegistrationRequest
389 389  
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.
389 +Element Documentation:
394 394  
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 -** RegistryInterfaceType (restriction)
401 -*** QueryRegistrationResponseType
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
402 402  
403 403  Content:
404 404  
... ... @@ -406,19 +406,18 @@
406 406  
407 407  Element Documentation:
408 408  
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.
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.
414 414  
415 415  **SubmitStructureRequestType: **SubmitStructureRequestType defines the structure of a registry submit structure request document.
416 416  
417 417  Derivation:
418 418  
419 -* //MessageType// (restriction)
420 -** RegistryInterfaceType (restriction)
421 -*** SubmitStructureRequestType
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
422 422  
423 423  Content:
424 424  
... ... @@ -426,152 +426,152 @@
426 426  
427 427  Element Documentation:
428 428  
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.
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.
433 433  
434 434  **SubmitStructureResponseType: **SubmitStructureResponseType defines the structure of a registry submit registration response document.
435 435  
436 436  Derivation:
437 437  
438 -* //MessageType// (restriction)
439 -** RegistryInterfaceType (restriction)
440 -*** SubmitStructureResponseType
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
441 441  
442 442  Content:
443 443  
444 -* Header, SubmitStructureResponse, ftr:Footer?
445 -* Element Documentation:
442 +Header, SubmitStructureResponse, ftr:Footer?
446 446  
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.
444 +Element Documentation:
452 452  
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 +
453 453  **SubmitSubscriptionsRequestType: **SubmitSubscriptionsRequestType defines the structure of a registry submit subscription request document.
454 454  
455 455  Derivation:
456 456  
457 -* //MessageType// (restriction)
458 -** RegistryInterfaceType (restriction)
459 -*** SubmitSubscriptionsRequestType
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
460 460  
461 461  Content:
462 462  
463 -* Header, SubmitSubscriptionsRequest
464 -* Element Documentation:
461 +Header, SubmitSubscriptionsRequest
465 465  
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.
463 +Element Documentation:
470 470  
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 +
471 471  **SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType defines the structure of a registry submit subscription response document.
472 472  
473 473  Derivation:
474 474  
475 -* //MessageType// (restriction)
476 -** RegistryInterfaceType (restriction)
477 -*** SubmitSubscriptionsResponseType
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
478 478  
479 479  Content:
480 480  
481 -* Header, SubmitSubscriptionsResponse, ftr:Footer?
482 -* Element Documentation:
479 +Header, SubmitSubscriptionsResponse, ftr:Footer?
483 483  
484 -(% style="width:843.294px" %)
485 -|**Name**|**Type**|(% style="width:362px" %)**Documentation**
486 -|Header|BasicHeaderType|(% style="width:362px" %)
487 -|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.
488 -|ftr:Footer|ftr:FooterType|(% style="width:362px" %)Footer is used to communicate information such as error and warnings after the payload of a message.
481 +Element Documentation:
489 489  
483 +|**Name**|**Type**|**Documentation**
484 +|Header|BasicHeaderType|
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.
486 +|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
487 +
490 490  **QuerySubscriptionRequestType: **QuerySubscriptionRequestType defines the structure of a registry query subscription request document.
491 491  
492 492  Derivation:
493 493  
494 -* //MessageType// (restriction)
495 -** RegistryInterfaceType (restriction)
496 -*** QuerySubscriptionRequestType
492 +//MessageType// (restriction)
493 + [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
494 + [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QuerySubscriptionRequestType
497 497  
498 498  Content:
499 499  
500 -* Header, QuerySubscriptionRequest
501 -* Element Documentation:
498 +Header, QuerySubscriptionRequest
502 502  
503 -(% style="width:839.294px" %)
504 -|(% style="width:230px" %)**Name**|(% style="width:254px" %)**Type**|(% style="width:352px" %)**Documentation**
505 -|(% style="width:230px" %)Header|(% style="width:254px" %)BasicHeaderType|(% style="width:352px" %)
506 -|(% 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.
500 +Element Documentation:
507 507  
502 +|**Name**|**Type**|**Documentation**
503 +|Header|BasicHeaderType|
504 +|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation.
505 +
508 508  **QuerySubscriptionResponseType: **QuerySubscriptionResponseType defines the structure of a registry query subscription response document.
509 509  
510 510  Derivation:
511 511  
512 -* //MessageType// (restriction)
513 -** RegistryInterfaceType (restriction)
514 -*** QuerySubscriptionResponseType
510 +//MessageType// (restriction)
511 + [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] RegistryInterfaceType (restriction)
512 + [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]] QuerySubscriptionResponseType
515 515  
516 516  Content:
517 517  
518 -* Header, QuerySubscriptionResponse, ftr:Footer?
519 -* Element Documentation:
516 +Header, QuerySubscriptionResponse, ftr:Footer?
520 520  
521 -(% style="width:912.294px" %)
522 -|**Name**|(% style="width:304px" %)**Type**|(% style="width:336px" %)**Documentation**
523 -|Header|(% style="width:304px" %)BasicHeaderType|(% style="width:336px" %)
524 -|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.
525 -|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.
518 +Element Documentation:
526 526  
520 +|**Name**|**Type**|**Documentation**
521 +|Header|BasicHeaderType|
522 +|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.
523 +|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message.
524 +
527 527  **NotifyRegistryEventType: **NotifyRegistryEventType defines the structure of a registry notification document.
528 528  
529 529  Derivation:
530 530  
531 -* //MessageType// (restriction)
532 -** RegistryInterfaceType (restriction)
533 -*** NotifyRegistryEventType
529 +//MessageType// (restriction)
530 + RegistryInterfaceType (restriction)
531 + NotifyRegistryEventType
534 534  
535 535  Content:
536 536  
537 -* Header, NotifyRegistryEvent
538 -* Element Documentation:
535 +Header, NotifyRegistryEvent
539 539  
540 -(% style="width:836.294px" %)
541 -|**Name**|**Type**|(% style="width:473px" %)**Documentation**
542 -|Header|BasicHeaderType|(% style="width:473px" %)
543 -|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.
537 +Element Documentation:
544 544  
539 +|**Name**|**Type**|**Documentation**
540 +|Header|BasicHeaderType|
541 +|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.
542 +
545 545  **DataQueryType: **DataQueryType defines the structure of a data query message.
546 546  
547 547  Derivation:
548 548  
549 -* //MessageType// (restriction)
550 -** DataQueryType
547 +//MessageType// (restriction)
548 + DataQueryType
551 551  
552 552  Content:
553 553  
554 -* Header, Query
555 -* Element Documentation:
552 +Header, Query
556 556  
557 -(% style="width:839.294px" %)
558 -|(% style="width:244px" %)**Name**|(% style="width:262px" %)**Type**|(% style="width:330px" %)**Documentation**
559 -|(% style="width:244px" %)Header|(% style="width:262px" %)BasicHeaderType|(% style="width:330px" %)
560 -|(% style="width:244px" %)Query|(% style="width:262px" %)qry:DataQueryType|(% style="width:330px" %)
554 +Element Documentation:
561 561  
556 +|**Name**|**Type**|**Documentation**
557 +|Header|BasicHeaderType|
558 +|Query|qry:DataQueryType|
559 +
562 562  **GenericDataQueryType: **DataQueryType defines the structure of a generic data query message.
563 563  
564 564  Derivation:
565 565  
566 -* //MessageType// (restriction)
567 -** DataQueryType (restriction)
568 -*** GenericDataQueryType
564 +//MessageType// (restriction)
565 + DataQueryType (restriction)
566 + GenericDataQueryType
569 569  
570 570  Content:
571 571  
572 -* Header, Query
573 -* Element Documentation:
570 +Header, Query
574 574  
572 +Element Documentation:
573 +
575 575  |**Name**|**Type**|**Documentation**
576 576  |Header|BasicHeaderType|
577 577  |Query|qry: GenericDataQueryType|