eligibility_tests

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

Overview

Name	eligibility_tests
Type	Resource
Id	ovh.connectivity.eligibility_tests

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
eligibility_reference	string	Eligibility unique reference (wire: eligibilityReference)
endpoint	object	Endpoint information
offers	array	Offers information

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	eligibility_reference		Returns the result of an eligibility test from its reference: the tested endpoint (address, copper or fiber details, portability) and the offers with their eligibility, estimated rates and reasons when not eligible.
address	exec			Starts an eligibility test on an address, given by its street code and street number or by its Hexacle. Get them with the search/streets and search/streetNumbers/details calls. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.
address_partners	exec			Starts an eligibility test on an address, given by its street code and street number or by its Hexacle. Reserved for partners. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.
building	exec	building		Starts an eligibility test on a building, for fiber only. Get the building identifier with the search/buildings calls. Set productFamily to scope the test (ISP by default). Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.
building_partners	exec	building		Starts an eligibility test on a building, for fiber only. Reserved for partners. Get the building identifier with the search/buildings calls. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.
line	exec	lineNumber, status		Starts an eligibility test on a line number, for copper only. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.
line_partners	exec	lineNumber, status		Starts an eligibility test on a line number, for copper only. Reserved for partners. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.
otp	exec	otp		Starts an eligibility test on an Optical Termination Panel (OTP) identifier, for fiber only. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.
otp_partners	exec	otp		Starts an eligibility test on an Optical Termination Panel (OTP) identifier, for fiber only. Reserved for partners. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.

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"}})
eligibility_reference	string	Eligibility reference (wire: eligibilityReference)

SELECT examples

get

Returns the result of an eligibility test from its reference: the tested endpoint (address, copper or fiber details, portability) and the offers with their eligibility, estimated rates and reasons when not eligible.

SELECT
eligibility_reference,
endpoint,
offers
FROM ovh.connectivity.eligibility_tests
WHERE eligibility_reference = '{{ eligibility_reference }}' -- required
;

Lifecycle Methods

EXEC variables use wire (API) names.

address

Starts an eligibility test on an address, given by its street code and street number or by its Hexacle. Get them with the search/streets and search/streetNumbers/details calls. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.

EXEC ovh.connectivity.eligibility_tests.address 
@@json=
'{
"hexacle": "{{ hexacle }}", 
"productFamily": "{{ productFamily }}", 
"streetAltCode": "{{ streetAltCode }}", 
"streetCode": "{{ streetCode }}", 
"streetNumber": "{{ streetNumber }}"
}'
;

address_partners

Starts an eligibility test on an address, given by its street code and street number or by its Hexacle. Reserved for partners. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.

EXEC ovh.connectivity.eligibility_tests.address_partners 
@@json=
'{
"hexacle": "{{ hexacle }}", 
"productFamily": "{{ productFamily }}", 
"streetAltCode": "{{ streetAltCode }}", 
"streetCode": "{{ streetCode }}", 
"streetNumber": "{{ streetNumber }}"
}'
;

building

Starts an eligibility test on a building, for fiber only. Get the building identifier with the search/buildings calls. Set productFamily to scope the test (ISP by default). Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.

EXEC ovh.connectivity.eligibility_tests.building 
@@json=
'{
"building": "{{ building }}", 
"productFamily": "{{ productFamily }}"
}'
;

building_partners

Starts an eligibility test on a building, for fiber only. Reserved for partners. Get the building identifier with the search/buildings calls. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.

EXEC ovh.connectivity.eligibility_tests.building_partners 
@@json=
'{
"building": "{{ building }}", 
"productFamily": "{{ productFamily }}"
}'
;

line

Starts an eligibility test on a line number, for copper only. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.

EXEC ovh.connectivity.eligibility_tests.line 
@@json=
'{
"lineNumber": "{{ lineNumber }}", 
"status": "{{ status }}", 
"streetCode": "{{ streetCode }}", 
"streetNumber": "{{ streetNumber }}"
}'
;

line_partners

Starts an eligibility test on a line number, for copper only. Reserved for partners. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.

EXEC ovh.connectivity.eligibility_tests.line_partners 
@@json=
'{
"lineNumber": "{{ lineNumber }}", 
"status": "{{ status }}", 
"streetCode": "{{ streetCode }}", 
"streetNumber": "{{ streetNumber }}"
}'
;

otp

Starts an eligibility test on an Optical Termination Panel (OTP) identifier, for fiber only. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.

EXEC ovh.connectivity.eligibility_tests.otp 
@@json=
'{
"otp": "{{ otp }}"
}'
;

otp_partners

Starts an eligibility test on an Optical Termination Panel (OTP) identifier, for fiber only. Reserved for partners. Returns an asynchronous task, pending until its result holds the eligibility reference, the endpoint and the eligible offers.

EXEC ovh.connectivity.eligibility_tests.otp_partners 
@@json=
'{
"otp": "{{ otp }}"
}'
;