GET_FEATURES

GET_FEATURES

Used in: REQUEST
Parent elements: REQUEST

<GET_FEATURES	Attribute Description Table
attributes ="true \| false" [true] beginrecord ="integer" [0] checkesc ="true \| false" [false] compact ="true \| false" [false] envelope ="true \| false" [false] featurelimit ="integer" [all features] geometry ="true \| false" [true] globalenvelope ="true \| false" [false] outputmode ="binary \| xml \| newxml" [binary] skipfeatures ="true \| false" [false] > <LAYER... /> <QUERY... /> [Or] <SPATIALQUERY... /> [Or] <ENVIRONMENT... /> </GET_FEATURES >
Bold: Attribute or child element is required.

Description:

Requests features as a compressed binary stream from the Feature Server or requests attribute data in ArcXML format from the Query Server.

Restrictions:

Can only be used on one layer at a time. Layer must exist in MapService.
Used only with Feature Server or Query Server.
Either SPATIALQUERY or QUERY is required.
Skipfeatures is valid only when outputmode is set to xml or newxml.

Notes:

See FEATURES for response.
A GET_FEATURES request to an Image MapService gets routed to the Query Server. This routing information is contained in the URL sent to the ArcIMS site such as in the following example (all one line):
http://myComputer.domain.com/servlet/com.esri.esrimap.Esrimap?ClientVersion=3.1
        &ServiceName=landuse
        &CustomService=Query
        &Form=True&Encode=True
The attributes beginrecord and featurelimit are used together to limit the number of features returned. Featurelimit is used to set the number of features returned. Beginrecord is used to start the retrieval at a specified record. For example, if 25 features should be returned, featurelimit is set to 25. For the first retrieval, beginrecord starts at 1 (the default). For the second retrieval, beginrecord should start at 26. To determine whether more than 25 features were extracted, the attribute hasmore in the FEATURES response will be set to true (more records) or false (no more records).
Outputmode defines whether the data is streamed to the client or sent to the client in ArcXML format. If outputmode is binary, then the request goes to the Feature Server and the response is a compressed binary stream. This is the default and is valid only for Feature MapServices. To return data in ArcXML format, outputmode can have one of two values: newxml or xml.

If outputmode="xml", then all features are returned in a short ArcXML format using the FIELDS element:
<FIELDS CUST_ID="4" NAME="Customer" #SHAPE#="[Geometry]" #ID#="3" />

If outputmode="newxml" then all fields are returned in a longer ArcXML format in the FIELD element:
<FIELDS>
  <FIELD name="CUST_ID" value="4" />
  <FIELD name="NAME" value="Customer" />
  <FIELD name="#SHAPE#" value="[Geometry]" />
  <FIELD name="#ID#" value="3" />
</FIELDS>
Compact can be used to switch the geometry used in the output ArcXML to a shortened format. When compact is true, the response uses the COORDS element:
<MULTIPOINT>
  <COORDS>-122.406680 37.747422;-123,500555 37.820000</COORDS>
</MULTIPOINT>

When compact is false, the response uses the POINT element:
<MULTIPOINT>
  <POINT x=-122.406680 y=37.747422 />
  <POINT x=-123,500555 y=37.820000 />
</MULTIPOINT>
For more details on using GET_FEATURES and FEATURES, including additional examples, see Using GET_FEATURES and FEATURES.

Attribute Descriptions for GET_FEATURES:

Attribute	Usage	Back to Top
attributes	Determines whether attribute data for selected features is returned in the response.
beginrecord	Index of first extracted record.
checkesc	Used to determine if the returned data should include escaped characters for ampersand, single quote, double quote, less than, and greater than. For example, if the value for SUB_REGION is "P&NW", then: If checkesc="false", in the response the value of SUB_REGION is "P&NW". If checkesc="true", the value of SUB_REGION is "P&NW".
compact	For ArcXML response, switches geometry to compact form. See Using GET_FEATURES and FEATURES for more details.
envelope	Used to request the bounding envelope of each returned feature.
featurelimit	Maximum number of returned features.
geometry	Requests feature coordinates.
globalenvelope	When set to true, the overall envelope for all the features returned is included in the response. Since the number of features returned depends on beginrecord and featurelimit, only the actual records extracted based on featurelimit are included in the overall envelope. Note that in order for the global envelope to be returned, subfields in the SPATIALQUERY must include either #SHAPE# or #ALL#.
outputmode	If outputmode is binary, data is compressed into a binary stream. This is valid only for feature MapServices. If the value of "xml" is used, data is returned in ArcXML format. This format uses a shorthand format that is faster to parse in an HTML client. If "newxml" is used, the data is returned in a longer format. See Using GET_FEATURES and FEATURES for more details.
skipfeatures	When set to true, only the number of features is returned without including any information on individual features. The number of features returned depends on beginrecord and featurelimit. To get the total number of features in a layer, a query can be specified with an empty where clause. Note that even when skipfeatures is set to true, the query is executed and features are actually extracted before they are counted. This attribute is valid only when outputmode is xml or newxml.

Examples for GET_FEATURES:

Example 1:	Back to Top
<?xml version="1.0" encoding="UTF-8"?> <ARCXML version="1.1"> <REQUEST> <GET_FEATURES featurelimit="25" beginrecord="0" outputmode="xml" geometry="false" envelope="true" compact="true"> <LAYER id="4" /> <SPATIALQUERY subfields="#ALL#" where="NAME = 'Los Angeles'" > </SPATIALQUERY> </GET_FEATURES> </REQUEST> </ARCXML>

Example 2: When using projection elements.

Back to Top

<?xml version="1.0" encoding="UTF-8" ?>
<ARCXML version="1.1">
  <REQUEST>
    <GET_FEATURES featurelimit="25" beginrecord="0" outputmode="xml" geometry="true" envelope="true" compact="true">
      <LAYER id="4" />
      <SPATIALQUERY subfields="#ALL#" where="POPULATION > 10000000" >
        <FILTERCOORDSYS id="53030" />
        <FEATURECOORDSYS id="53030" />
        <SPATIALFILTER relation="area_intersection">
          <ENVELOPE minx="-11395772" miny="930558" maxx="-3878142" maxy="6419621"/>
        </SPATIALFILTER>
      </SPATIALQUERY>
    </GET_FEATURES>
  </REQUEST>
</ARCXML>