GetPropertyValue Request |
The main request parameters of the KVP encoding request for the GetPropertyValue operation are shown in the following table:
Table 1 Main Request Parameters for the GetPropertyValue Operation
Request parameters | Whether it is required | Description |
VERSION |
Yes |
Request version number. Request for WFS 2.0.0 service. The request version number needs to be set to "2.0.0". |
SERVICE |
Yes |
Service type Request WFS 2.0.0 service. The service type needs to be set to "WFS". |
REQUEST |
Yes |
Request name A GetPropertyValue operation was requested. The request name needs to be set to "GetPropertyValue". |
NAMESPACES |
No |
Namespace. Used to specify the namespace and its prefix in the form xmlns (prefixed with escaped_URL). If the prefix is not defined, the default namespace should be declared. Multiple namespaces of the xmlns() value can be connected by commas in English. |
VSPs |
No |
Provider-specific parameters. Optional service providers vendor-specific parameters (VSPs) are allowed in the GetPropertyValue request. These parameters are specified by the vendor and are not part of the international standard. KVP parameter. The use of these parameters enhances the result of the response to the request. The service can provide a default value when VSPs are missing or incorrect. When VSPs are applied without being known by the service, the service may choose to ignore the unknown request parameters. WFS may choose not to declare some or all of the VSPs. ExtendedCapabilities if VSPs are included in Capabilities XML Element should be expanded accordingly. Other Schema documents that contain Extended Capabilities extension elements can be imported into Capabilities. In an XML document. The client can read the service providers-specific definitions from the Capabilities Schema and use the VSPs to compose the request. WFS Implementers should be careful when choosing names for VSPs so that they do not conflict with the WFS parameters defined in international standards. This parameter is not currently supported by SuperMap iServer. |
STARTINDEX |
No |
Start index number. Specifies the index number at which the result set begins to render in the response document. |
COUNT |
No |
Return quantity. Specifies the number of elements to include in the returned results. |
OUTPUTFORMAT |
No |
Response result encoding format. Defines the encoding format of the response result resource after the Get PropertyValue operation is executed. The default value is "application/gml+xml;version=3.2". This default value indicates that the response resources listed in the document should use GML3.2 encoding. |
RESULTTYPE |
No |
Return type. The GetPropertyValue operation for the WFS 2.0.0 service supports two formats (except for response exceptions). You can return either a complete response document that contains the resources that satisfy the request, or an empty response document that indicates the total number of resources that can be returned by the operation. The final returned document type is specified by RESULTTYPE The parameters determine. The RESULTTYPE parameter can have the values "results" and "hits", with the default value being "results". "results" means to return a complete response document that satisfies the operation request, and "hits" means to return an empty response document without a resource instance. |
VALUEREFERENCE |
Yes |
Attribute field name. The VALUEREFERENCE parameter is an XPath expression that identifies the feature attribute field of a node or child node. Feature attribute field values should be obtained from the server data store and reported in the response document. If the property value is the index of the remote resource, you can use the ValueOf () access function resolves the remote value. |
RESOLVEPATH |
No |
Modify parameter behavior. When this parameter is used, the RESOLVE parameter has no meaning. The RESOLVEPATH parameter value can be obtained through the valueOf () access function. This parameter is not currently supported by SuperMap iServer. |
Adhoc Query Keywords |
- |
See Table 2 for specific parameters in the Adhoc Query Keywords. Adhoc Query Keywords and Stored Query Keywords are mutually exclusive. |
Stored Query Keywords |
- |
See Table 3 for specific parameters in the Stored Query Keywords. Stored Query Keywords and Adhoc Query Keywords are mutually exclusive. |
The KVP encoding request parameters included in the Adhoc Query Keywords are shown in the following table:
Table 2 Request Parameters in the Adhoc Query Keywords.
Request parameters | Whether it is required | Description |
TYPENAMES |
Yes |
List of
feature types. Multiple element types can be specified through this parameter, and different element types are separated by commas. Required at all times except when the RESOURCEID parameter is specified. |
ALIASES |
No |
Element alias. Alias used in the query request to specify the feature type. The value is specified by the TYPENAMES parameter. The element alias can be used anywhere, and the element type name can only be used in the context of a query request. The element alias is used as follows: TYPENAMES=(ns1:FeatureType1,ns2:FeatureType2)(ns2:FeatureType2,ns2:FeatureType3)&ALIASES=(A,B)(C,D) This parameter is not currently supported by SuperMap iServer. |
SRSNAME |
No |
Coordinate reference system name. Base on that value of the SRSNAME attribute in the response document, you can determine which of the CRS transformations apply to geometric features that the WFS service supports. The SRSNAME property value may be The DefaultCRS or OtherCRS value for the feature type listed in the capabilities document. If the SRSNAME attribute value is not specified, the element types listed in the response document should use the The DefaultCRS value encoding. This parameter is not currently supported by SuperMap iServer. |
PROPERTYNAME |
No |
List of attribute names. Represents a list of non-required attributes to include in the response. If more than one feature type name is specified as the value of TYPENAMES, the corresponding list parameter should be specified. |
RESOLVE |
No |
Resource reference. The RESOLVE parameter represents a resource reference of choice, such as a local or remote resource. Values can be local, remote, all, or none. WFS The supported values for the RESOLVE parameter of the 2.0.0 service are declared in the capabilties XML document. This parameter is not currently supported by SuperMap iServer. |
RESOLVEDEPTH |
No |
Resource nesting depth.
The RESOLVEDEPTH parameter determines the depth of resource nesting in the response document. The range of valid values for this parameter consists of non-negative integers plus "*". If RESOLVE is not specified Parameter or the value is set to none, the server ignores any value specified in the RESOLVEDEPTH parameter. This parameter is not currently supported by SuperMap iServer. |
RESOLVETIMEOUT |
No |
Resource resolution time. The RESOLVETIMEOUT parameter determines how long the server waits from when the resource reference is resolved to when the server receives a response. If the RESOLVE parameter value is set to The none, RESOLVE TIMEOUT parameter value is not valid.This parameter is not currently supported by SuperMap iServer. |
FILTER |
No |
Filter expression. A filter expression that uses the language encoding specified by the FILTER_LANGUAGE parameter. This parameter is mutually exclusive with the BBOX and RESOURCEID parameters. |
FILTER_LANGUAGE |
No |
Filtered expression encoding language. Used to specify the language of the encoded filter expression. The value of the FILTER parameter is the encoded filter expression. Default values for FILTER_LANGUAGE parameter urn:ogc:def:query Language:OGC-FES:Filter to indicate that the value of the FILTER parameter is a string that is defined using international standards XML tag encoded. This parameter is not currently supported by SuperMap iServer. |
RESOURCEID |
No |
Resource identifier. A list of resource identifiers (separated by commas) obtained from the data store. This parameter is mutually exclusive with the BBOX and FILTER parameters. |
BBOX |
No |
Bounding box. This parameter is mutually exclusive with the RESOURCEID and FILTER parameters. See Bounding Box . |
SORTBY |
No |
Sort the
attributes by. This parameter is used to specify the sorting method of the attribute, which can be ascending sorting (ASC) or descending sorting (DESC). If sorting is not specified, sorting in ascending order (ASC) is the default. For example, "SORTBY=Field1 DESC,Field2 DESC,Field3" means Field1 Sort in descending order, Field2 in descending order, Field3 in ascending order. |
The KVP encoding request parameters included in the Stored Query Keywords are shown in the following table:
Table 3 Request Parameters in the Stored Query Keywords.
Request parameters | Whether it is required | Description |
STOREDQUERY_ID |
Yes |
Store the query identifier. SuperMap iServer only provides the Get FeatureById storage and query method, and its corresponding identifier is urn:ogc:def:query:OGC-WFS::GetFeatureById. |
STOREDQUERY_PARAMETER |
No |
Store query param. KVP encoding should be used to store query param, and the name used to store query param should not conflict with the parameter name in WFS. |
The GetPropertyValue operation supports both Query and StoredQuery.
1.Query Request Example
<ServiceRoot>?SERVICE=WFS&VERSION=version&REQUEST=GetPropertyValue&TYPENAMES=type_list&VALUEREFERENCE=fieldname&FILTER=filter
ServiceRoot is the URI root directory of the service. Please refer to URI settings .
For example, after the successful startup of the SuperMap iServer WFS 2.0.0 service on the local machine, the URI for accessing the GetPropertyValue operation is: http://localhost:8090/iserver/services/data-world/wfs200?SERVICE=WFS&VERSION=2.0.0&REQUEST=GetPropertyValue&TYPENAMES=World:Capitals&VALUEREFERENCE=CAPITAL&FILTER=<fes:Filter><fes:And><fes:PropertyIsEqualTo><fes:ValueReference>World:COUNTRY</fes:ValueReference><fes:Literal>United States</fes:Literal></fes:PropertyIsEqualTo><fes:PropertyIsEqualTo><fes:ValueReference>World:CAPITAL</fes:ValueReference><fes:Literal>Washington DC</fes:Literal></fes:PropertyIsEqualTo></fes:And></fes:Filter>.
The response result of this request example is shown in the response example .
That is, the http://localhost:8090/iserver/services/data-world/wfs200 , execute the POST request, and the request body is as follows:
<?xml version="1.0"?>
<wfs:GetPropertyValue service="WFS" version="2.0.0"
valueReference="World:CAPITAL" outputFormat="application/gml+xml; version=3.2"
xmlns:wfs="http://www.opengis.net/wfs/2.0" xmlns:fes="http://www.opengis.net/fes/2.0"
xmlns:gml="http://www.opengis.net/gml/3.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.opengis.net/wfs/2.0
http://schemas.opengis.net/wfs/2.0.0/wfs.xsd
http://www.opengis.net/gml/3.2
http://schemas.opengis.net/gml/3.2.1/gml.xsd">
<wfs:Query typeNames="World:Capitals">
<fes:Filter>
<fes:And>
<fes:PropertyIsEqualTo>
<fes:ValueReference>World:COUNTRY</fes:ValueReference>
<fes:Literal>美国</fes:Literal>
</fes:PropertyIsEqualTo>
<fes:PropertyIsEqualTo>
<fes:ValueReference>World:CAPITAL</fes:ValueReference>
<fes:Literal>华盛顿</fes:Literal>
</fes:PropertyIsEqualTo>
</fes:And>
</fes:Filter>
</wfs:Query>
</wfs:GetPropertyValue>
The response result of this request example is shown in the Response example .
2.StoredQuery Request Example
<ServiceRoot>?SERVICE=WFS&VERSION=version&REQUEST=GetPropertyValue&VALUEREFERENCE=fieldname&STOREDQUERY_ID=storedquery_id&STOREDQUERY_PARAMETER=storedquery_parameter
ServiceRoot is the URI root directory of the service. Please refer to URI settings .
For example, after the successful startup of the SuperMap iServer WFS 2.0.0 service on the local machine, the URI for accessing the VNet pertyValue operation is: http://localhost:8090/iserver/services/data-world/wfs200?SERVICE=WFS&VERSION=2.0.0&REQUEST=GetPropertyValue&VALUEREFERENCE=CAPITAL&STOREDQUERY_ID=urn:ogc:def:query:OGC-WFS::GetFeatureById&ID=World.Capitals.8.
The response result of this request example is shown in the Response example .
That is http://localhost:8090/iserver/services/data-world/wfs200 , execute the POST request, and the request body is as follows:
<?xml version="1.0"?>
<wfs:GetPropertyValue service="WFS" version="2.0.0"
valueReference="World:capital" outputFormat="application/gml+xml; version=3.2"
xmlns:wfs="http://www.opengis.net/wfs/2.0" xmlns:fes="http://www.opengis.net/fes/2.0"
xmlns:gml="http://www.opengis.net/gml/3.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.opengis.net/wfs/2.0
http://schemas.opengis.net/wfs/2.0.0/wfs.xsd
http://www.opengis.net/gml/3.2
http://schemas.opengis.net/gml/3.2.1/gml.xsd">
<wfs:StoredQuery id="urn:ogc:def:query:OGC-WFS::GetFeatureById">
<wfs:Parameter name="id">World.Capitals.8</wfs:Parameter>
</wfs:StoredQuery>
</wfs:GetPropertyValue>
The response result of this request example is shown in the Response example .