eligibility_search_cities

Creates, updates, deletes, gets or lists an eligibility_search_cities resource.

Overview

Name	eligibility_search_cities
Type	Resource
Id	ovh.connectivity.eligibility_search_cities

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create	insert	zip_code		Returns, as an asynchronous task, the cities and localities linked to a zip code with their INSEE code. Use the INSEE code to search the streets of a locality.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})

INSERT examples

create

Returns, as an asynchronous task, the cities and localities linked to a zip code with their INSEE code. Use the INSEE code to search the streets of a locality.

INSERT INTO ovh.connectivity.eligibility_search_cities (
zip_code
)
SELECT 
'{{ zip_code }}' /* required */
RETURNING
error,
result,
status
;

Manifest

# Description fields are for documentation purposes
- name: eligibility_search_cities
props:
  - name: zip_code
    value: "{{ zip_code }}"
    description: |
      Zip code