Changes for page Part I. Message Namespace
Last modified by Artur on 2025/09/10 11:19
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -368,36 +368,37 @@ 368 368 * Header, SubmitRegistrationsResponse, ftr:Footer? 369 369 * Element Documentation: 370 370 371 -|**Name**|**Type**|**Documentation** 372 -|Header|BasicHeaderType| 373 -|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. 374 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message. 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. 375 375 376 376 **QueryRegistrationRequestType: **QueryRegistrationRequestType defines the structure of a registry query registration request document. 377 377 378 378 Derivation: 379 379 380 -//MessageType// (restriction) 381 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]RegistryInterfaceType (restriction)382 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]QueryRegistrationRequestType381 +* //MessageType// (restriction) 382 +** RegistryInterfaceType (restriction) 383 +*** QueryRegistrationRequestType 383 383 384 384 Content: 385 385 386 -Header, QueryRegistrationRequest 387 +* Header, QueryRegistrationRequest 388 +* Element Documentation: 387 387 388 -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. 389 389 390 -|**Name**|**Type**|**Documentation** 391 -|Header|BasicHeaderType| 392 -|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. 393 - 394 394 **QueryRegistrationResponseType: **SubmitRegistrationRequestType defines the structure of a registry submit registration response document. 395 395 396 396 Derivation: 397 397 398 -//MessageType// (restriction) 399 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]RegistryInterfaceType (restriction)400 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]QueryRegistrationResponseType399 +* //MessageType// (restriction) 400 +** RegistryInterfaceType (restriction) 401 +*** QueryRegistrationResponseType 401 401 402 402 Content: 403 403 ... ... @@ -405,18 +405,19 @@ 405 405 406 406 Element Documentation: 407 407 408 -|**Name**|**Type**|**Documentation** 409 -|Header|BasicHeaderType| 410 -|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. 411 -|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. 412 412 413 413 **SubmitStructureRequestType: **SubmitStructureRequestType defines the structure of a registry submit structure request document. 414 414 415 415 Derivation: 416 416 417 -//MessageType// (restriction) 418 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]RegistryInterfaceType (restriction)419 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]SubmitStructureRequestType419 +* //MessageType// (restriction) 420 +** RegistryInterfaceType (restriction) 421 +*** SubmitStructureRequestType 420 420 421 421 Content: 422 422 ... ... @@ -424,206 +424,206 @@ 424 424 425 425 Element Documentation: 426 426 427 -|**Name**|**Type**|**Documentation** 428 -|Header|BasicHeaderType| 429 -|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. 430 430 431 431 **SubmitStructureResponseType: **SubmitStructureResponseType defines the structure of a registry submit registration response document. 432 432 433 433 Derivation: 434 434 435 -//MessageType// (restriction) 436 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]RegistryInterfaceType (restriction)437 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]SubmitStructureResponseType438 +* //MessageType// (restriction) 439 +** RegistryInterfaceType (restriction) 440 +*** SubmitStructureResponseType 438 438 439 439 Content: 440 440 441 -Header, SubmitStructureResponse, ftr:Footer? 444 +* Header, SubmitStructureResponse, ftr:Footer? 445 +* Element Documentation: 442 442 443 -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. 444 444 445 -|**Name**|**Type**|**Documentation** 446 -|Header|BasicHeaderType| 447 -|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. 448 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message. 449 - 450 450 **SubmitSubscriptionsRequestType: **SubmitSubscriptionsRequestType defines the structure of a registry submit subscription request document. 451 451 452 452 Derivation: 453 453 454 -//MessageType// (restriction) 455 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]RegistryInterfaceType (restriction)456 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]SubmitSubscriptionsRequestType457 +* //MessageType// (restriction) 458 +** RegistryInterfaceType (restriction) 459 +*** SubmitSubscriptionsRequestType 457 457 458 458 Content: 459 459 460 -Header, SubmitSubscriptionsRequest 463 +* Header, SubmitSubscriptionsRequest 464 +* Element Documentation: 461 461 462 -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. 463 463 464 -|**Name**|**Type**|**Documentation** 465 -|Header|BasicHeaderType| 466 -|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. 467 - 468 468 **SubmitSubscriptionsResponseType: **SubmitSubscriptionsResponseType defines the structure of a registry submit subscription response document. 469 469 470 470 Derivation: 471 471 472 -//MessageType// (restriction) 473 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]RegistryInterfaceType (restriction)474 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]SubmitSubscriptionsResponseType475 +* //MessageType// (restriction) 476 +** RegistryInterfaceType (restriction) 477 +*** SubmitSubscriptionsResponseType 475 475 476 476 Content: 477 477 478 -Header, SubmitSubscriptionsResponse, ftr:Footer? 481 +* Header, SubmitSubscriptionsResponse, ftr:Footer? 482 +* Element Documentation: 479 479 480 -Element Documentation: 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 481 482 -|**Name**|**Type**|**Documentation** 483 -|Header|BasicHeaderType| 484 -|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. 485 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message. 486 - 487 487 **QuerySubscriptionRequestType: **QuerySubscriptionRequestType defines the structure of a registry query subscription request document. 488 488 489 489 Derivation: 490 490 491 -//MessageType// (restriction) 492 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]RegistryInterfaceType (restriction)493 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]QuerySubscriptionRequestType494 +* //MessageType// (restriction) 495 +** RegistryInterfaceType (restriction) 496 +*** QuerySubscriptionRequestType 494 494 495 495 Content: 496 496 497 -Header, QuerySubscriptionRequest 500 +* Header, QuerySubscriptionRequest 501 +* Element Documentation: 498 498 499 -Element Documentation: 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 500 501 -|**Name**|**Type**|**Documentation** 502 -|Header|BasicHeaderType| 503 -|QuerySubscriptionReq uest|ref: QuerySubscriptionReq uestType|QuerySubscriptionRequest is used to query the registry for the subscriptions of a given organisation. 504 - 505 505 **QuerySubscriptionResponseType: **QuerySubscriptionResponseType defines the structure of a registry query subscription response document. 506 506 507 507 Derivation: 508 508 509 -//MessageType// (restriction) 510 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]RegistryInterfaceType (restriction)511 - [[image:Macintosh%20HD:Users:j:Documents:workspace_neon:xsd-docuementation:output:inherit.gif||alt="-"]]QuerySubscriptionResponseType512 +* //MessageType// (restriction) 513 +** RegistryInterfaceType (restriction) 514 +*** QuerySubscriptionResponseType 512 512 513 513 Content: 514 514 515 -Header, QuerySubscriptionResponse, ftr:Footer? 518 +* Header, QuerySubscriptionResponse, ftr:Footer? 519 +* Element Documentation: 516 516 517 -Element Documentation: 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 518 519 -|**Name**|**Type**|**Documentation** 520 -|Header|BasicHeaderType| 521 -|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. 522 -|ftr:Footer|ftr:FooterType|Footer is used to communicate information such as error and warnings after the payload of a message. 523 - 524 524 **NotifyRegistryEventType: **NotifyRegistryEventType defines the structure of a registry notification document. 525 525 526 526 Derivation: 527 527 528 -//MessageType// (restriction) 529 - 530 - 531 +* //MessageType// (restriction) 532 +** RegistryInterfaceType (restriction) 533 +*** NotifyRegistryEventType 531 531 532 532 Content: 533 533 534 -Header, NotifyRegistryEvent 537 +* Header, NotifyRegistryEvent 538 +* Element Documentation: 535 535 536 -Element Documentation: 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 537 538 -|**Name**|**Type**|**Documentation** 539 -|Header|BasicHeaderType| 540 -|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. 541 - 542 542 **DataQueryType: **DataQueryType defines the structure of a data query message. 543 543 544 544 Derivation: 545 545 546 -//MessageType// (restriction) 547 - 549 +* //MessageType// (restriction) 550 +** DataQueryType 548 548 549 549 Content: 550 550 551 -Header, Query 554 +* Header, Query 555 +* Element Documentation: 552 552 553 -Element Documentation: 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 554 555 -|**Name**|**Type**|**Documentation** 556 -|Header|BasicHeaderType| 557 -|Query|qry:DataQueryType| 558 - 559 559 **GenericDataQueryType: **DataQueryType defines the structure of a generic data query message. 560 560 561 561 Derivation: 562 562 563 -//MessageType// (restriction) 564 - 565 - 566 +* //MessageType// (restriction) 567 +** DataQueryType (restriction) 568 +*** GenericDataQueryType 566 566 567 567 Content: 568 568 569 -Header, Query 572 +* Header, Query 573 +* Element Documentation: 570 570 571 -Element Documentation: 575 +(% style="width:833.294px" %) 576 +|(% style="width:213px" %)**Name**|(% style="width:243px" %)**Type**|(% style="width:374px" %)**Documentation** 577 +|(% style="width:213px" %)Header|(% style="width:243px" %)BasicHeaderType|(% style="width:374px" %) 578 +|(% style="width:213px" %)Query|(% style="width:243px" %)qry: GenericDataQueryType|(% style="width:374px" %) 572 572 573 -|**Name**|**Type**|**Documentation** 574 -|Header|BasicHeaderType| 575 -|Query|qry: GenericDataQueryType| 576 - 577 577 **GenericTimeSeriesDataQueryType: **GenericTimeSeriesDataQueryType defines the structure of a time series generic data query message. 578 578 579 579 Derivation: 580 580 581 -//MessageType// (restriction) 582 - 583 - 584 - 584 +* //MessageType// (restriction) 585 +** DataQueryType (restriction) 586 +*** GenericDataQueryType (restriction) 587 +**** GenericTimeSeriesDataQueryType 585 585 586 586 Content: 587 587 588 -Header, Query 591 +* Header, Query 592 +* Element Documentation: 589 589 590 -Element Documentation: 594 +(% style="width:909.294px" %) 595 +|(% style="width:221px" %)**Name**|(% style="width:305px" %)**Type**|(% style="width:380px" %)**Documentation** 596 +|(% style="width:221px" %)Header|(% style="width:305px" %)BasicHeaderType|(% style="width:380px" %) 597 +|(% style="width:221px" %)Query|(% style="width:305px" %)qry: GenericTimeSeriesDat aQueryType|(% style="width:380px" %) 591 591 592 -|**Name**|**Type**|**Documentation** 593 -|Header|BasicHeaderType| 594 -|Query|qry: GenericTimeSeriesDat aQueryType| 595 - 596 596 **StructureSpecificTimeSeriesDataQueryType: **StructureSpecificTimeSeriesDataQueryType defines the structure of a time series generic data query message. 597 597 598 598 Derivation: 599 599 600 -//MessageType// (restriction) 601 - 602 - 603 +* //MessageType// (restriction) 604 +** DataQueryType (restriction) 605 +*** StructureSpecificTimeSeriesDataQueryType 603 603 604 604 Content: 605 605 606 -Header, Query 609 +* Header, Query 610 +* Element Documentation: 607 607 608 -Element Documentation: 612 +(% style="width:903.294px" %) 613 +|(% style="width:189px" %)**Name**|(% style="width:259px" %)**Type**|(% style="width:452px" %)**Documentation** 614 +|(% style="width:189px" %)Header|(% style="width:259px" %)BasicHeaderType|(% style="width:452px" %) 615 +|(% style="width:189px" %)Query|(% style="width:259px" %)qry: TimeSeriesDataQueryType|(% style="width:452px" %) 609 609 610 -|**Name**|**Type**|**Documentation** 611 -|Header|BasicHeaderType| 612 -|Query|qry: TimeSeriesDataQueryT ype| 613 - 614 614 **MetadataQueryType: **MetadataQueryType defines the structure of a reference metadata query message. 615 615 616 616 Derivation: 617 617 618 -//MessageType// (restriction) 619 - 621 +* //MessageType// (restriction) 622 +** MetadataQueryType 620 620 621 621 Content: 622 622 623 -Header, Query 626 +* Header, Query 627 +* Element Documentation: 624 624 625 -Element Documentation: 626 - 627 627 |**Name**|**Type**|**Documentation** 628 628 |Header|BasicHeaderType| 629 629 |Query|qry: MetadataQueryType|