what3wordsweb

This configuration is required when using the plugin What3Words.

  • Documentation

  • YAML Format

  • XML Format

Fill relevant inputs (blue boxes) and click the blue bars on the left to copy XML configuration snippets.
<what3wordsConfiguration
<services
>
requiredmax. 1
<service
id
required
=
string

Unique ID for the connection. It is required when configuring functions that use the service.

<url
>
required
string

Url of the what3words service

</url>
<language
>
required
string

Language of the what3words service (de for German, en for English, check what3words documentation for other supported languages),

</language>
<apiKey
>
required
string

API key (by default encoded) used to authenticate to the what3words geocoding service. To encode API keys, see also Secrets in Configuration.

</apiKey>
<authentication
<userName
>
required
string
</userName>
<password
>
required
string
</password>
>
optional

User name ("userName") and password ("password", by default encoded) used to authenticate to the what3words service (alternatively to API key). To encode passwords, see also Secrets in Configuration.

</authentication>
>
requiredmax. unbounded

Configuration of a single service providing the what3words functionality. Any number of services can be configured.

</service>
</services>
>
required

Configuration settings regarding the access to what3word geocoding services. Any number of services can be configured.

</what3wordsConfiguration>
This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.
cadenzaconfig:
  settings:
    what3wordsweb:
      services:
      - id: "text"
        url: "text"
        language: "text"
        apiKey: "text"
        authentication:
          userName: "text"
          password: "text"
      - id: "text"
        url: "text"
        language: "text"
        apiKey: "text"
        authentication:
          userName: "text"
          password: "text"

Filename: what3wordsweb-config.xml

This is a generated sample file with fake data and all the possible options shown, refer to the Documentation tab for what combinations are valid and what is required or not.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<what3wordsConfiguration>
  <services>
    <service id="text">
      <url>text</url>
      <language>text</language>
      <apiKey>text</apiKey>
      <authentication>
        <userName>text</userName>
        <password>text</password>
      </authentication>
    </service>
    <service id="text">
      <url>text</url>
      <language>text</language>
      <apiKey>text</apiKey>
      <authentication>
        <userName>text</userName>
        <password>text</password>
      </authentication>
    </service>
  </services>
</what3wordsConfiguration>