xsd.2_0.SDMXQuery.xsd Maven / Gradle / Ivy







	
		
			The Query message allows standard querying of SDMX-compliant databases and web services. It is intended to be used in non-registry exchanges, and is focused on data sets and metadata sets. It allows queries to retrieve data, metadata, key families, metadata structure definitions, codelists, concepts, and other structural metadata. Note that date and time formats are structured according to the common:TimePeriodType, rather than being specified in the query. The response documents for this query mesage are data formats (for data queries), metadata formats (for metadata queries), and the SDMX Structure MEssage (for all other queries).
		
	
	
		
			The Query element is a top-level element for this namespace, which is referenced by the SDMX message envelope, or could be put inside another envelope, such as SOAP. It contains a query. The defaultLimit attribute is the suggested maximum response size in kilobytes.
		
		
			
						
			
			
			
			
			
			
						
			
			
			
							
			
			
			
					
		
		
	
	
		
			The DataWhere element representes a query for data. It contains all of the clauses in that query, represented by its child elements. Values are the IDs of the referenced object.
		
		
			
			
				
			
			
			
			
			
			
			
			
			
			
		
	
	
		
			The MetadataWhere element representes a query for metadata. It contains all of the clauses in that query, represented by its child elements. Values are the IDs of the referenced object.
		
		
			
			
				
			
			
			
			
			
			
			
			
			
			
		
		
		
	

	
		
			 For the And element, each of its immediate child elements represent clauses all of which represent conditions which must be satisfied. If children are A, B, and C, then any legitimate response will meet conditions A, B, and C.  Values are the IDs of the referenced object.
			
                     
			
			
			
						
			
							
			
			
			
			
			
			
			
			
			
						
			
			
		
	
	
		
			The Or element's immediate children represent clauses in the query any one of which is sufficient to satisfy the query. If these children are A,  B, and C, then any result which meets condition A, or condition B, or condition C is a match for that query. Values are the IDs of the referenced object.
			
		
			
			
			
			
			
						
			
			
			
			
			
			
			
			
			
						
			
					
	
	
		
			Dimension elements contain the  (single) value being searched on within the key of the data set. The id attribute holds the ID of the dimension. If the content is empty, then the query is for any dimension with the given name. If the name attribute is not supplied, then the query is for the given key value within any dimension.
			
		
			
				
			
		
	
	
		
			StructureComponent elements contain the  (single) value being searched on within the key of data set, but this value can be either a code value or the alias assigned to a set of equivalent code values. The id attribute holds the ID of the dimension, attribute, or alias assigned to a component in a structure set. If the content is empty, then the query is for any component with the given name or alias. If the name attribute is not supplied, then the query is for the given code value or alias within any component or component alias.
			
		
			
				
			
		
		
	
		
			Attribute elements contain the (single) value of an attribute being queried for. The id attribute contains the id of the attribute. The attachmentLevel attribute specifies the attachment level of the attribute. If the content of Attribute is empty, then the search is for the specified attribute (and attachment level). If the name attribute is not specified, then the search is on any attribute. If the attachmentLevel attribute is not specified, then the query is for an attribute at any attachment level, as the value defaults to "Any".
			
		
			
				
				
			
		
	
	
		
			This type supplies an enumeration of attachment levels corresponding to those in the SDMX Information Model, plus a value of "Any" where the search is wildcarded.
			
		
			
				
					Attached at the Data Set level
				
			
			
				
					Attached at the Group level
				
						
			
				
					Attached at the Series level
				
						
			
				
					Attached at the Observation level
				
						
			
				
					Attached at any attachment level
				
						
		
	
	
		
			The Codelist element allows queries to specify a (single) value found within a codelist as the element content, and the agency-qualified name of the codelist being queried for in the name attribute. If no content is supplied, then the query is for the named codelist. If the id attribute is left empty, then the value is searched for in any codelist.
			
		
			
				
			
		
	
	
		
			The Category element allows for a search to be made on the values within a specific category, which is specified (in agency-qualified form) with the name attribute. If there is no element content, then the search is for the named Category; if the name is not supplied, then the category value supplied as content should be sought-for in all available categories.
			
		
			
				
				
				
				
				
			
		
	
	
		
			The KeyFamilyWhere element representes a query for a key family or key families. It contains all of the clauses in that query, represented by its child elements. Values are the IDs of the referenced object.
			
		
			
			
			
			
			
			
			
						
			
			
		
	
	
	
		
			The MetadataStructureWhere element representes a query for a metadata structure or structures. It contains all of the clauses in that query, represented by its child elements. Values are the IDs of the referenced object.
			
		
			
			
						
			
			
			
			
			
			
			
						
			
			
		
		
	
			
				The CodelistWhere element representes a query for a codelist or codelists. It contains all of the clauses in that query, represented by its child elements. Values are the IDs of the referenced object.
				

		
			
			
			
			
			
		
	
	
		
			The ConceptWhere element representes a query for a concept or concepts. It contains all of the clauses in that query, represented by its child elements. Values are the IDs of the referenced object.
			
	
		
			
			
						
			
			
		
	
	
		
			The AgencyWhere element representes a query for details for an Agency. It contains all of the clauses in that query, represented by its child elements. Values are the IDs of the referenced object.
			
		
			
			
			
			
			
			
			
			
			
		
	
	
		
			The DataProviderWhere element representes a query for details for a provider of data or metadata sets. It contains all of the clauses in that query, represented by its child elements. Values are the IDs of the referenced object.
			
		
			
						
			
			
			
			
			
			
			
			
			
		
	
	
	
	
		
			TimeType contains the time point or period for which results should be supplied. When StartTime and EndTime are used, these must be understood as inclusive.
			
	
		
			
				
							
			
			
		
	
	
	
	
		
			The StructureSetWhere element represents a query for a structure set or structure sets. Like other maintainable objects, it must be queried for using information about its agency, ID, and/or version. Any field not supplied will be taken as matching all of that type.
			
		
			
			
			
						
			
		
			
	
		
			The HierarchicalCodelistWhere element represents a query for a hierarchical codelist or codelists. Like other maintainable objects, it must be queried for using information about its agency, ID, and/or version. Any field not supplied will be taken as matching all of that type.
			
		
			
			
			
						
			
		
			
	
		
			The ReportingTaxonomyWhere element represents a query for a reporting taxonomy or taxonomies. Like other maintainable objects, it must be queried for using information about its agency, ID, and/or version. Any field not supplied will be taken as matching all of that type.
			
		
			
			
			
						
			
		
			
	
		
			The DataflowWhereType element represents a query for a dataflow or dataflows. Like other maintainable objects, it must be queried for using information about its agency, ID, and/or version. Any field not supplied will be taken as matching all of that type.
			
		
			
			
			
						
			
		
			
	
		
			The MetadataflowWhereType element represents a query for a metadataflow or metadataflows. Like other maintainable objects, it must be queried for using information about its agency, ID, and/or version. Any field not supplied will be taken as matching all of that type.
			
		
			
			
			
						
			
		
			
	
		
			The ProcessWhere element represents a query for a process or processes. Like other maintainable objects, it must be queried for using information about its agency, ID, and/or version. Any field not supplied will be taken as matching all of that type.
			
		
			
			
			
						
			
		
			
	
		
			The OrganisationSchemeWhere element represents a query for an organisation scheme or schemes. Like other maintainable objects, it must be queried for using information about its agency, ID, and/or version. Any field not supplied will be taken as matching all of that type.
			
		
			
			
			
						
			
		
			
	
		
			The ConceptSchemeWhere element represents a query for a concept scheme or schemes. Like other maintainable objects, it must be queried for using information about its agency, ID, and/or version. Any field not supplied will be taken as matching all of that type.
			
		
			
			
			
						
			
		
			
	
		
			The CategorySchemeWhere element represents a query for a category scheme or schemes. Like other maintainable objects, it must be queried for using information about its agency, ID, and/or version. Any field not supplied will be taken as matching all of that type.