---
title: "WFS interface"
slug: "wfs-interface-3-1-1-1"
updated: 2024-09-23T06:54:30Z
published: 2024-11-27T10:49:04Z
canonical: "support.keypro.fi/wfs-interface-3-1-1-1"
excludeFromSearch: true
excludeFromExternalSearch: true
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.keypro.fi/llms.txt
> Use this file to discover all available pages before exploring further.

# WFS interface

KeyCom can use and display external WFS service data through the WFS interface.

## WFS Service

- Url: address of the WFS service, such as. http://myserver.com/geoserver/service/wfs
- Version: WFS protocol version. The current recommendation is WFS v_1.1_.
- Capabilities xml: collection of WFS features in XML format. This must be compiled manually by combining the service address and a search string, for example, http://myserver.com/geoserver/service/wfs?SERVICE=WFS&VERSION=1.1.0&REQUEST=GetCapabilities.
- Options: Currently, an empty JSON collection: {}.

## WFS Resource

- Name: a user-friendly name for the WFS meta resource.
- Form: A description for the form fields (see the [Defining the WFS resource form](/docs/wfs-interface-3-1-1-1#_WFS-resurssin_lomakkeen_m%C3%A4%C3%A4ritt%C3%A4min) chapter).
- Options: options related to searching and displaying WFS data:
  - id_attr: name of the id field.
  - geometry_attr: name of the geometry attribute field.
  - item_label_format: label format according to Python’s format specification.
  - attributes: list of the fields to be retrieved. May include localisation.
- Service: The WFS service being used (see the [WFS](/docs/wfs-interface-3-1-1-1#_WFS-Service) service chapter).
- Typename: field name offered by the selected WFS service.
- Description xml: a description of WFS features in XML format. This must be compiled manually by combining the service address and a search string, for example,http://myserver.com/geoserver/service/wfs?SERVICE=wfs&VERSION=1.1.0&REQUEST=describefeaturetype&TYPENAME=typename  
Note that the TYPENAME parameter must be the same as the Typename defined above.
- ID:

### Defining the WFS resource form

The form must be defined in JSON format.

![](https://cdn.document360.io/672fb328-110d-4b2d-9d5f-f1e71883bb64/Images/Documentation/wfs-interface-image-5h7wzhn6.png)