# Module: ol/format/WFS

This documentation is for OpenLayers v10.9.0. The latest is v.

## ol/format/WFS

### Classes

WFS

### Functions

#### writeFilter(filter, version){Node}

format/WFS.js, line 1344

      import {writeFilter} from 'ol/format/WFS';

  Encode filter as WFS `Filter` and return the Node.

  Name | Type | Description
  --- | --- | ---
  `filter` | Filter | Filter.
  `version` | string | WFS version. If not provided defaults to '1.1.0'

  ##### Returns:

  Result.

### Type Definitions

#### FeatureCollectionMetadata{Object}

  Number of features; bounds/extent.

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `numberOfFeatures` | number | NumberOfFeatures.
  `bounds` | Extent | Bounds.

#### FeatureType{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `name` | string | The feature type name.
  `bbox` | Extent | Extent to use for the BBOX filter.
  `geometryName` | string | Geometry name to use in the BBOX filter.

#### Options{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `featureNS` | Object.<string, string> | string | undefined | The namespace URI used for features.
  `featureType` | Array.<string> | string | undefined | The feature type to parse. Only used for read operations.
  `gmlFormat` | GMLBase | undefined | The GML format to use to parse the response. Default is `ol/format/GML2` for WFS 1.0.0, `ol/format/GML3` for WFS 1.1.0 and `ol/format/GML32` for WFS 2.0.0.
  `schemaLocation` | string | undefined | Optional schemaLocation to use for serialization, this will override the default.
  `version` | string (defaults to '1.1.0') | WFS version to use. Can be either `1.0.0`, `1.1.0` or `2.0.0`.

#### TransactionResponse{Object}

  Total deleted; total inserted; total updated; array of insert ids.

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `transactionSummary` | TransactionSummary | Transaction summary.
  `insertIds` | Array.<string> | InsertIds.

#### TransactionSummary{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `totalDeleted` | number | TotalDeleted.
  `totalInserted` | number | TotalInserted.
  `totalUpdated` | number | TotalUpdated.

#### WriteGetFeatureOptions{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `featureNS` | string | The namespace URI used for features.
  `featurePrefix` | string | The prefix for the feature namespace.
  `featureTypes` | Array.<(string|module:ol/format/WFS~FeatureType)> | The feature type names or FeatureType objects to define a unique bbox filter per feature type name (in this case, options `bbox` and `geometryName` are ignored.).
  `srsName` | string | undefined | SRS name. No srsName attribute will be set on geometries when this is not provided.
  `handle` | string | undefined | Handle.
  `outputFormat` | string | undefined | Output format.
  `maxFeatures` | number | undefined | Maximum number of features to fetch.
  `geometryName` | string | undefined | Geometry name to use in a BBOX filter.
  `propertyNames` | Array.<string> | undefined | Optional list of property names to serialize.
  `viewParams` | string | undefined | viewParams GeoServer vendor parameter.
  `startIndex` | number | undefined | Start index to use for WFS paging. This is a WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services.
  `count` | number | undefined | Number of features to retrieve when paging. This is a WFS 2.0 feature backported to WFS 1.1.0 by some Web Feature Services. Please note that some Web Feature Services have repurposed `maxfeatures` instead.
  `bbox` | Extent | undefined | Extent to use for the BBOX filter. The `geometryName` option must be set.
  `filter` | Filter | undefined | Filter condition. See `ol/format/filter` for more information.
  `resultType` | string | undefined | Indicates what response should be returned, e.g. `hits` only includes the `numberOfFeatures` attribute in the response and no features.

#### WriteTransactionOptions{Object}

  ##### Properties:

  Name | Type | Description
  --- | --- | ---
  `featureNS` | string | The namespace URI used for features.
  `featurePrefix` | string | The prefix for the feature namespace.
  `featureType` | string | The feature type name.
  `srsName` | string | undefined | SRS name. No srsName attribute will be set on geometries when this is not provided.
  `handle` | string | undefined | Handle.
  `hasZ` | boolean | undefined | Must be set to true if the transaction is for a 3D layer. This will allow the Z coordinate to be included in the transaction.
  `nativeElements` | Array.<Object> | Native elements. Currently not supported.
  `gmlOptions` | Options | undefined | GML options for the WFS transaction writer.
  `version` | string (defaults to '1.1.0') | WFS version to use for the transaction. Can be either `1.0.0`, `1.1.0` or `2.0.0`.