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.

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="QueryRegistrationRequestType">
  <xs:annotation>
   <xs:documentation>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.</xs:documentation>
  </xs:annotation>
  <xs:sequence>
   <xs:element name="QueryType" type="QueryTypeType">
    <xs:annotation>
     <xs:documentation>QueryType defines the type of sets (data, metadata, or both) that are being queried for.</xs:documentation>
    </xs:annotation>
   </xs:element>
   <xs:choice>
    <xs:element name="All" type="common:EmptyType">
     <xs:annotation>
      <xs:documentation>All indicates that all registrations meeting the other criteria of the query should be returned.</xs:documentation>
     </xs:annotation>
    </xs:element>
    <xs:element name="ProvisionAgreement" type="common:ProvisionAgreementReferenceType">
     <xs:annotation>
      <xs:documentation>ProvisionAgreement provides a reference to a provision agreement in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.</xs:documentation>
     </xs:annotation>
    </xs:element>
    <xs:element name="DataProvider" type="common:DataProviderReferenceType">
     <xs:annotation>
      <xs:documentation>DataProvider provides a reference to a data provider in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.</xs:documentation>
     </xs:annotation>
    </xs:element>
    <xs:element name="Dataflow" type="common:DataflowReferenceType">
     <xs:annotation>
      <xs:documentation>Dataflow provides a reference to a data flow in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.</xs:documentation>
     </xs:annotation>
    </xs:element>
    <xs:element name="Metadataflow" type="common:MetadataflowReferenceType">
     <xs:annotation>
      <xs:documentation>Metadataflow provides a reference to a metadata flow in the registry, for which all registered sets meeting the other criteria of this query should be returned. The reference is provided as a URN and/or a complete set of reference fields.</xs:documentation>
     </xs:annotation>
    </xs:element>
   </xs:choice>
   <xs:element name="ReferencePeriod" type="common:ReferencePeriodType" minOccurs="0">
    <xs:annotation>
     <xs:documentation>ReferencePeriod provides an inclusive start and end date for the data or metadata being sought.</xs:documentation>
    </xs:annotation>
   </xs:element>
   <xs:choice minOccurs="0" maxOccurs="unbounded">
    <xs:element name="DataKeySet" type="structure:DataKeySetType">
     <xs:annotation>
      <xs:documentation>DataKeySet is used to provide a set of included or excluded keys which serves to refine the data being sought.</xs:documentation>
     </xs:annotation>
    </xs:element>
    <xs:element name="CubeRegion" type="structure:CubeRegionType">
     <xs:annotation>
      <xs:documentation>CubeRegion is used to provide sets of include or excluded values for dimensions when querying for data.</xs:documentation>
     </xs:annotation>
    </xs:element>
    <xs:element name="MetadataTargetRegion" type="structure:MetadataTargetRegionType">
     <xs:annotation>
      <xs:documentation>MetadataTargetRegion is used to provide sets of included or excluded values for identifier components when querying for metadata.</xs:documentation>
     </xs:annotation>
    </xs:element>
   </xs:choice>
  </xs:sequence>
  <xs:attribute name="returnConstraints" type="xs:boolean" default="false">
   <xs:annotation>
    <xs:documentation>The returnConstraints attribute determines whether information about the constraints on the data or metadata sets returned should also be sent the results.</xs:documentation>
   </xs:annotation>
  </xs:attribute>
 </xs:complexType>