1 Introduction

The registry schemas have been updated to reflect the various changes in the standard and to introduce new constructs for managing subscriptions. In addtion, the constructs that had existed for querying structural metadata have been removed as this is now handled by the query messages.

As was done with the query, the registry message set now contains distinct messages for each operation. The messages will eventually allow the registry to function in more standard web service mannter.

2 Schema Documentation

2.1 Registry Namespace

http://www.sdmx.org/resources/sdmxml/schemas/v3_1/registry

2.1.1 Summary

Referenced Namespaces:

Contents:
39 Complex Types  
5 Simple Types

2.1.2 Complex Types

RegistrationType: Registration provides the information needed for data and reference metadata set registration. A data source must be supplied here if not already provided in the provision agreement. The data set or metadata set must be associated with a provision agreement, a metadata flow, or a dataflow definition. If possible, the provision agreement should be specified. Only in cases where this is not possible should the dataflow or metadata flow be used.

Attributes:
id?, validFrom?, validTo?, lastUpdated?, indexTimeSeries?, indexDataSet?, indexAttributes?, indexReportingPeriod?

Content:
ProvisionAgreement, Datasource

Attribute Documentation:

Element Documentation:

DataSourceType: DataSourceType specifies the properties of a data or metadata source. Either a simple data source, a queryable data source, or both must be specified.

Content:
(SimpleDataSource | QueryableDataSource) [1..2]

Element Documentation:

SimpleDataSourceType: SimpleDataSourceType describes a simple data source. The URL of the data is contained in the content.

Derivation:

 xs:anySimpleType (restriction)  
   xs:anyURI (extension)  
          SimpleDataSourceType

Attributes:
TYPE?

Content:
Attribute Documentation:

QueryableDataSourceType: QueryableDataSourceType describes a queryable data source, and add a fixed attribute for ensuring only one queryable source can be provided.

Derivation:

QueryableDataSourceType (extension)  
   QueryableDataSourceType

Attributes:
isRESTDatasource, isWebServiceDatasource, TYPE?

Content:
DataURL, WSDLURL?, WADLURL?

Attribute Documentation:

Element Documentation:

IdentifiableQueryType: IdentifiableQueryType describes the structure of a query for an identifiable object.

Attributes:
id?

Content:
{Empty}

Attribute Documentation:

VersionableQueryType: VersionableQueryType describes the structure of a query for a versionable object.

Derivation:

IdentifiableQueryType (extension)  
   VersionableQueryType

Attributes:
id?, version?

Content:
{Empty}

Attribute Documentation:

MaintainableQueryType: MaintainableQueryType describes the structure of a query for a maintainable object.

Derivation:

IdentifiableQueryType (extension)  
   VersionableQueryType (extension)  
         MaintainableQueryType

Attributes:
id?, version?, agencyID?

Content:
{Empty}

Attribute Documentation:

StatusMessageType: StatusMessageType carries the text of error messages and/or warnings in response to queries or requests.

Attributes:
status

Content:
MessageText

Attribute Documentation:

Element Documentation:

SubmitRegistrationsRequestType: SubmitRegistrationsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of data/metadata set registrations.

Content:
RegistrationRequest+

Element Documentation:

RegistrationRequestType: RegistrationRequestType describes the structure of a single registration request. It contains the details of a registation and an action field to indicate the action to be taken on the contained registration.

Attributes:
action

Content:
Registration

Attribute Documentation:

Element Documentation:

SubmitRegistrationsResponseType: SubmitRegistrationsResponseType describes the structure of a registration response. For each submitted registration in the request, a registration status is provided. The status elements should be provided in the same order as the submitted registrations, although each status will echo the request to ensure accurate processing of the responses.

Content:
RegistrationStatus+

Element Documentation:

RegistrationStatusType: RegistrationStatusType describes the structure of a registration status.

Content:
Registration, StatusMessage

Element Documentation:

QueryRegistrationRequestType: QueryRegistrationRequestType describes the structure of a registration query request. The type of query (data, reference metadata, or both) must be specified. It is possible to query for registrations for a particular provision agreement, data provider, or structure usage, or to query for all registrations in the registry. In addition the search can be refined by providing constraints in the form of explicit time periods, constraint regions, and key sets. When constraint regions and key sets are provided they will be effectively processed by first matching all data for the included keys and regions (all available data if there are none) and then removing any data matching the excluded keys or regions.

Attributes:
returnConstraints?

Content:
QueryType, (All | ProvisionAgreement | DataProvider | Dataflow | Metadataflow), ReferencePeriod?, (DataKeySet | CubeRegion | MetadataTargetRegion)

Attribute Documentation:

Element Documentation:

QueryRegistrationResponseType: QueryRegistrationResponseType describes the structure of a registration query response. It provides a status for the request, and if successful, the resulting data and/or metadata results.

Content:
StatusMessage, QueryResult

Element Documentation:

QueryResultType: QueryResultType describes the structure of a query result for a single data source. Either a data result or metadata result is detailed, depending on the data source.

Attributes:
timeSeriesMatch

Content:
(DataResult | MetadataResult)

Attribute Documentation:

Element Documentation:

ResultType:

ResultType contains the details about a data or metadata source, through the complete registration information. In addition, a reference to the content constraints for the data source may be provided, if the query requested this information.

Content:
Registration, Constraint

Element Documentation:

SubmitStructureRequestType: SubmitStructureRequestType describes the structure of a structure submission. Structural components are provided either in-line or referenced via a SDMX-ML Structure message external to the registry. A default action and external reference resolution action are all provided for each of the contained components, but can be overridden on a per component basis.

Attributes:
action?, externalDependencies?

Content:
(StructureLocation | Structures), SubmittedStructure

Attribute Documentation:

Element Documentation:

SubmittedStructureType: SubmittedStructureType generally references a submitted structural object. When used in a submit structure request, its purpose is to override the default action or external dependency resolution behavior. If neither of these indicators are set, then it will be ignored. In a submit structure response, it is used to reference a submitted object for the purpose of providing a status for the submission. In this case, the action attribute should be populated in order to echo the requested action.

Attributes:
action?, externalDependencies?

Content:
MaintainableObject

Attribute Documentation:

Element Documentation:

SubmitStructureResponseType: SubmitStructureResponseType describes the structure of a response to a structure submission. For each submitted structure, a Result will be returned.

Content:
SubmissionResult+

Element Documentation:

SubmissionResultType: SubmissionResultType provides the status of the structural object submission request. It will identify the object submitted, report back the action requested, and convey the status and any error messages which are relevant to the submission.

Content:
SubmittedStructure, StatusMessage

Element Documentation:

SubmitSubscriptionsRequestType: SubmitSubscriptionsRequestType defines the payload of a request message used to submit addtions, updates, or deletions of subscriptions. Subscriptions are submitted to the registry to subscribe to registration and change events for specific registry resources.

Content:
SubscriptionRequest+

Element Documentation:

SubscriptionType: SubscriptionType describes the details of a subscription to a registration or change event for registry resources. When it occurs as the content of a response message, the registry URN must be provide, unless the response is a failure notification for the creation of a new subscription.

Content:
Organisation, RegistryURN?, NotificationMailTo*, NotificationHTTP*, SubscriberAssignedID?, ValidityPeriod, EventSelector

Element Documentation:

SubscriptionRequestType: SubscriptionRequestType describes the structure of a single subscription request. It contains subscription details and an action field to indicate the action to be taken on the contained subscription. Note that if the action is update or delete, then the registry supplied URN for the subscription must be included.

Attributes:
action

Content:
Subscription

Attribute Documentation:

Element Documentation:

SubmitSubscriptionsResponseType: SubmitSubscriptionsResponseType describes the structure of the response to a new subscription submission. A status is provided for each subscription in the request.

Content:
SubscriptionStatus+

Element Documentation:

SubscriptionStatusType: SubscriptionStatusType describes the structure a status for a single subscription request.

Content:
SubscriptionURN?, SubscriberAssignedID?, StatusMessage

Element Documentation:

QuerySubscriptionRequestType: QuerySubscriptionRequestType describes the structure of a query for subscriptions. Subscriptions for a given organisation may be retrieved.

Content:
Organisation

Element Documentation:

QuerySubscriptionResponseType: QuerySubscriptionResponseType describes the structure of a subscription query response. A status will describe the success or failure of the request (and provide error or warning messages if necessary). If the query was successful, details of all of the organisation's subscriptions will be provided.

Content:
StatusMessage, Subscription

Element Documentation:

NotifyRegistryEventType: NotifyRegistryEventType describes the structure a registry notification, in response to a subscription to a registry event. At a minimum, the event time, a reference to the change object, a reference to the underlying subscription triggering the notification, and the action that took place on the object are sent. In addition, the full details of the object may be provided at the discretion of the registry. In the event that the details are not sent, it will be possible to query for the details of the changed object using the reference provided.

Content:
EventTime, (ObjectURN | RegistrationID), SubscriptionURN, EventAction, (StructuralEvent | RegistrationEvent)?

Element Documentation:

NotificationURLType: NotificationURLType describes the structure of an http or email address. The content holds the addresses while an attribute indicates whether or not is expects the contents in a SOAP message.

Derivation:

xs:anySimpleType (restriction)  
   xs:anyURI (extension)  
         NotificationURLType

Attributes:
isSOAP?

Content:
Attribute Documentation:

ValidityPeriodType: ValidityPeriodType specifies inclusive start and end-dates for the subscription period.

Content:
StartDate, EndDate

Element Documentation:

EventSelectorType: EventSelectorType describes the details of the events for a subscription. It allows subscribers to specify registry and repository events for which they wish to receive notifications.

Content:

(Structura l RepositoryEvents | DataRegistrationEvents | MetadataRegistrationEvents) [1..3]

Element Documentation:

StructuralRepositoryEventsType: StructuralRepositoryEventsType details the structural events for the subscription. At least one maintenance agency must be specified, although it may be given a wildcard value (meaning the subscription is for the structural events of all agencies). This can also be a list of agencies to allow the subscription to subscribe the events of more than one agency. It should be noted that when doing so, all of the subsequent objects are assumed to apply to every agency in the list. The subscription is then refined by detailing the structural objects maintained by the agency for which the subscription should apply. It is possible to explicitly select all object events, all objects of given types, or to individually list out specific objects. Note that for any object, it is also possible to provide an explicit URN to reference a distinct object. In this case, the reference to maintenance agency described above is ignored. Although it is not required, if specific objects are being referenced by explicit URNs, it is good practice to list the agencies.

Attributes:
TYPE?

Content:
AgencyID+, (AllEvents|(AgencyScheme | DataConsmerScheme | DataProviderScheme | OrganisationUnitScheme | Dataflow | Metadataflow | CategoryScheme | Categorisation | Codelist | Hierarchica l Codelist | ConceptScheme | MetadataStructureDefinition | KeyFamily | StructureSet | ReportingTaxonomy | Process | AttachmentConstraint | ContentConstraint | ProvisionAgreement | TransformationScheme | NameAliasScheme | NamePersonalisationScheme | RulesetScheme | UserDefinedOperatorScheme)+)

Attribute Documentation:

Element Documentation:

IdentifiableObjectEventType: IdentifiableObjectEventType describes the structure of a reference to an identifiable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.

Content:
(All | URN | ID)

Element Documentation:

VersionableObjectEventType: VersionableObjectEventType describes the structure of a reference to a versionable object's events. Either all instances of the object matching the inherited criteria, a specific instance, or specific instances of the object may be selected.

Content:
(All|URN | (ID, Version))

Element Documentation:

DataRegistrationEventsType: DataRegistrationEventsType details the data registration events for the subscription. It is possible to subscribe to all data registration events in the repository, or specific events for; single registrations, provision agreements, data providers, data flows, key families, and categories that categorize data flows or key families.

Attributes:
TYPE?

Content:
(AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | DataflowReference | KeyFamilyReference |Category)+)

Attribute Documentation:

Element Documentation:

MetadataRegistrationEventsType: MetadataRegistrationEventsType details the metadata registration events for the subscription. It is possible to subscribe to all metadata registration events in the repository, or specific events for; single registrations, provision agreements, data providers, metadata flows, metadata structure definitions, and categories that categorize metadata flows or metadata structure definitions.

Attributes:
TYPE?

Content:
(AllEvents | (RegistrationID | ProvisionAgreement | DataProvider | MetadataflowReference | MetadataStructureDefinitionReference | Category)+)

Attribute Documentation:

Element Documentation:

MaintainableEventType: MaintainableEventType provides a reference to a maintainable object's event with either the URN of the specific object, or a set of potentially wild-carded reference fields.

Content:
(URN | Ref)

Element Documentation:

StructuralEventType: StructuralEventType provides the details of a structure event, specifically the object that changed.

Content:
Structures

Element Documentation:

RegistrationEventType: This provides the details of a data or metadata registration event for the purposes of notification.

Content:
Registration

Element Documentation:

2.1.3 Simple Types

IDQueryType: IDQueryType is a simple type that allows for an identifier to be substituted with a wild card character ("%").

Union of:
IDType, WildCardValueType.

NestedIDQueryType: NestedIDQueryType is a simple type that allows for a nested identifier to be substituted with a wild card character ("%").

Union of:
NestedIDType, WildCardValueType.

VersionQueryType: VersionQueryType is a simple type that allows for a version number to be substituted with a wild card character ("%") or a late bound character ("\*").

Union of:
LegacyVersionNumberType, SemanticVersionNumberType, SemanticVersionReferenceType, WildcardType, WildCardValueType.

StatusType: StatusType provides an enumeration of values that detail the status of queries or requests.

Derived by restriction of xs:NMTOKEN.

Enumerations:

QueryTypeType: QueryType provides an enumeration of values which specify the objects in the result-set for a registry query.

Derived by restriction of xs:NMTOKEN.

Enumerations: