@vertigis/viewer-spec/messaging/schema/web-geocode-operation-definitions.md

VertiGIS Viewer Specification

# operation: geocode.active-geocoders
Description: Returns the active configured geocoders. Web only.

Inputs: `None`

Outputs: `@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.Geocoder[]`

---
# operation: geocode.batch-geocode
Description: Finds locations corresponding to multiple addresses. The geocoder must have the supportsBatchGeocoding capability. Web only.

Inputs: `BatchGeocodeArgs`

BatchGeocodeArgs properties:
```json
{
  "addresses": {
    "description": "The addresses to look up.",
    "items": {
      "$ref": "#/definitions/AddressLike",
      "AddressLike": {}
    },
    "type": "array",
    "isRequired": "true"
  },
  "options": {
    "description": "Options that affect geocode results.",
    "isRequired": "true"
  }
}
```

Outputs: `Features`

---
# operation: geocode.count
Description: Counts the number of locations corresponding to an address.

Inputs: `GeocodeArgs`

GeocodeArgs properties:
```json
{
  "address": {
    "description": "The address to look up.",
    "isRequired": "true"
  },
  "options": {
    "description": "Options that affect geocode results.",
    "isRequired": "true"
  }
}
```

Outputs: `@vertigis.arcgis-extensions.tasks.CountResult.CountResult`

---
# operation: geocode.geocode
Description: Finds one or more locations corresponding to an address.

Inputs: `GeocodeArgs`

GeocodeArgs properties:
```json
{
  "address": {
    "description": "The address to look up.",
    "isRequired": "true"
  },
  "options": {
    "description": "Options that affect geocode results.",
    "isRequired": "true"
  }
}
```

Outputs: `Features`

---
# operation: geocode.get-geocoders
Description: Returns all configured geocoders including the active ones. Web only.

Inputs: `None`

Outputs: `@vertigis.arcgis-extensions.tasks.geocoding.Geocoder.Geocoder[]`

---
# operation: geocode.reverse-geocode
Description: Finds the address at a particular location. The geocoder must have the supportsReverseGeocoding capability.

Inputs: `ReverseGeocodeArgs`

ReverseGeocodeArgs properties:
```json
{
  "geometry": {
    "description": "The location to look up.",
    "isRequired": "true"
  },
  "options": {
    "description": "Options that affect geocode results.",
    "isRequired": "true"
  }
}
```

Outputs: `unknown`

---
# operation: geocode.suggest
Description: Suggests matching addresses to search for based on some input text. The geocoder must have the supportsSuggest capability.

Inputs: `SuggestArgs`

SuggestArgs properties:
```json
{
  "options": {
    "description": "Options that affect geocode results.",
    "isRequired": "true"
  },
  "searchText": {
    "description": "The search text entered by the user.",
    "type": "string",
    "isRequired": "true"
  }
}
```

Outputs: `string[]`

---