eligibility_search_buildings

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

Overview

Name	eligibility_search_buildings
Type	Resource
Id	ovh.connectivity.eligibility_search_buildings

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			Returns, as an asynchronous task, the buildings at an address with their reference, name, type, NRO and stairs. The address needs at least a street code and street number, or a Hexacle.

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 buildings at an address with their reference, name, type, NRO and stairs. The address needs at least a street code and street number, or a Hexacle.

INSERT INTO ovh.connectivity.eligibility_search_buildings (
hexacle,
street_alt_code,
street_code,
street_number
)
SELECT 
'{{ hexacle }}',
'{{ street_alt_code }}',
'{{ street_code }}',
'{{ street_number }}'
RETURNING
error,
result,
status
;

Manifest

# Description fields are for documentation purposes
- name: eligibility_search_buildings
props:
  - name: hexacle
    value: "{{ hexacle }}"
    description: |
      Hexacle is a French unique identifier of the address (you can get it with POST /connectivity/eligibility/search/streetNumbers/details)
  - name: street_alt_code
    value: "{{ street_alt_code }}"
    description: |
      A possible alternative identifier of the street (you can get it with POST /connectivity/eligibility/search/streets)
  - name: street_code
    value: "{{ street_code }}"
    description: |
      Unique identifier of the street (you can get it with POST /connectivity/eligibility/search/streets)
  - name: street_number
    value: "{{ street_number }}"
    description: |
      Street number