Introduction KVP encoding GetRecords operation

GetDomain service = CSW version = 2.0.2 xmlns = http:www.opengis.netcatcsw2.0.2 xmlns:csw = http:www.opengis.netcatcsw2.0.2 xmlns:xsi = http:www.w3.org2001XMLSchema-instance xsi:schemaLocation = http:www.opengis.netcatcsw2.0.2 ......csw2.0.2CSW-discovery.xsd ParameterName GetRecords.outputFormat ParameterName GetDomain

10.8 GetRecords operation

10.8.1 Introduction

The primary means of resource discovery in the general model are the two operations search and present. In the HTTP protocol binding these are combined in the form of the mandatory GetRecords operation, which does a search and a piggybacked present. The search portion of the GetRecords operation is encoded using the Query element. The Query element includes the parameters typeName and Constraint. The typeName parameter is used to specify which entities, from the information model of the catalogue, shall be queried. The Constraint parameter is used to specify which query constraints shall be applied to identify the request set. The present portion of the GetRecords operation is encoded using the outputSchema parameter and the ElementNameElementSetName parameters. The outputSchema parameter indicates which schema shall be used to generate the response to the GetRecords operation. The ElementName or ElementSetName parameter is used to specify which properties of the outputSchema to include in each record in the GetRecords response.

10.8.2 KVP encoding

Table 65 specifies the keyword-value pair encoding for the GetRecords operation request. This encoding is suitable for the HTTP GET binding. NOTE To reduce the need for readers to refer to other parts of this document, the first three parameters listed below are copied from Table 57 in Subclause 10.3.5 of this document. 142 Copyright © 2007 Open Geospatial Consortium, Inc. All Rights Reserved. Table 65 — KVP encoding for GetRecords operation request Keyword d Data type and value Optionality and use Parameter in general model REQUEST Character String Fixed value of GetRecords, case insensitive One Mandatory a none service Character String Fixed values of “CSW” One Mandatory serviceId version Character String Fixed value of 2.0.2 One Mandatory none NAMESPACE List of Character String, comma separated Used to specify a namespace and its prefix Format shall be xmlns[prefix=]namespace-url. If the prefix is not specified then this is the default namespace. Zero or one Optional b Include value for each distinct namespace used by all qualified names in the request. If not included, all qualified names are in default namespace none resultType CodeList with allowed values: ”hits” , “results” or ”validate” Zero or one Optional Default value is ”hits” resultType requestId URI Zero or one Optional Include when client chooses to assign requestId requestId outputFormat Character String Value is Mime type The only value that is required to be supported is applicationxml. Other supported values may include texthtml and textplain Zero or one Optional Default value is applicationxml returnFormat outputSchema Any URI.. Zero or one Optional Default value is http:www.opengis. netcatcsw2.0.2. responseSchema startPosition Non-Zero Positive Integer Zero or one Optional Default value is 1 cursorPosition maxRecords Positive Integer Zero or one Optional Default values is 10 iteratorSize Copyright © 2007 Open Geospatial Consortium, Inc. All Rights Reserved. 143 Keyword d Data type and value Optionality and use Parameter in general model typeNames List of Character String, comma separated Unordered List of object types implicated in the query One Mandatory collectionID ElementSetName List of Character String Zero or one Mutually exclusive with ElementName responseElements ElementName List of Character String Zero or more Mutually exclusive with ElementSetName responseElements CONSTRAINTLANGUAGE CodeList with allowed values: CQL_TEXT or FILTER Zero or one Optional c Include when Constraint included queryLanguage Constraint Character String Predicate expression specified in the language indicated by the CONSTRAINTLANGUAGE parameter Zero or one Optional Default action is to execute an unconstrained query predicate SortBy List of Character String, comma separated Ordered list of names of metadata elements to use for sorting the response Format of each list item is metadata_element_name:A indicating an ascending sort or metadata_ element_name:D indicating descending sort Zero or one Optional Default action is to present the records in the order in which they are retrieved sortField and sortOrder DistributedSearch Boolean Zero or one Optional Default value is FALSE queryScope hopCount Integer Zero or one Optional Include only if DistributedSearch parameter is included Default value is 2 queryScope ResponseHandler Any URI Zero or one Optional If not included, process request synchronously responseHandler 144 Copyright © 2007 Open Geospatial Consortium, Inc. All Rights Reserved. Keyword d Data type and value Optionality and use Parameter in general model a The REQUEST parameter contains the same information as the name of the GetRecords element in XML encoding.