fiber_eligibilities

Creates, updates, deletes, gets or lists a fiber_eligibilities resource.

Overview

Name	fiber_eligibilities
Type	Resource
Id	ovh.xdsl.fiber_eligibilities

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Identifier
building_seq_id	integer	Building sequence id (wire: buildingSeqId)
building_name	string	Building name (wire: buildingName)
availability_date	string (date-time)	Availability date (wire: availabilityDate)
building_reference	string	Building reference (wire: buildingReference)
copper_grid_closure_trajectory	object	Copper grid closure trajectory (wire: copperGridClosureTrajectory)
copper_nra_closure_trajectory	object	Copper NRA closure trajectory (wire: copperNraClosureTrajectory)
first_copper_closure	object	First copper closure details, if applicable (wire: firstCopperClosure)
first_eligible_date	string (date-time)	First eligible date (wire: firstEligibleDate)
grts	array	Available GRTs
last_update	string (date-time)	Last update date (wire: lastUpdate)
offer	object	Offer
provider	object	Provider
status	string	Status (eligible, no_building, not_eligible, not_yet_eligible)

list

Fiber eligibility

Name	Datatype	Description
id	integer	Identifier
building_seq_id	integer	Building sequence id (wire: buildingSeqId)
building_name	string	Building name (wire: buildingName)
availability_date	string (date-time)	Availability date (wire: availabilityDate)
building_reference	string	Building reference (wire: buildingReference)
copper_grid_closure_trajectory	object	Copper grid closure trajectory (wire: copperGridClosureTrajectory)
copper_nra_closure_trajectory	object	Copper NRA closure trajectory (wire: copperNraClosureTrajectory)
first_copper_closure	object	First copper closure details, if applicable (wire: firstCopperClosure)
first_eligible_date	string (date-time)	First eligible date (wire: firstEligibleDate)
grts	array	Available GRTs
last_update	string (date-time)	Last update date (wire: lastUpdate)
offer	object	Offer
provider	object	Provider
status	string	Status (eligible, no_building, not_eligible, not_yet_eligible)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Returns the fiber offer, provider, status, building and availability date of the access address, and the copper network closure schedule.
list	select	service_name	status, x_pagination_mode	Returns the IDs of the fiber eligibility checks of the access address. Filter by status: eligible, not_eligible, not_yet_eligible or no_building.

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"}})
id	integer	Id
service_name	string	Service name (wire: serviceName)
status	string	Filter the value of status property (=)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Returns the fiber offer, provider, status, building and availability date of the access address, and the copper network closure schedule.

SELECT
id,
building_seq_id,
building_name,
availability_date,
building_reference,
copper_grid_closure_trajectory,
copper_nra_closure_trajectory,
first_copper_closure,
first_eligible_date,
grts,
last_update,
offer,
provider,
status
FROM ovh.xdsl.fiber_eligibilities
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the IDs of the fiber eligibility checks of the access address. Filter by status: eligible, not_eligible, not_yet_eligible or no_building.

SELECT
id,
building_seq_id,
building_name,
availability_date,
building_reference,
copper_grid_closure_trajectory,
copper_nra_closure_trajectory,
first_copper_closure,
first_eligible_date,
grts,
last_update,
offer,
provider,
status
FROM ovh.xdsl.fiber_eligibilities
WHERE service_name = '{{ service_name }}' -- required
AND status = '{{ status }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;