eligibility_recalls

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

Overview

Name	eligibility_recalls
Type	Resource
Id	ovh.connectivity.eligibility_recalls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	ID
completed	boolean	Is the recall completed ?
completed_date	string (date-time)	Completed date (wire: completedDate)
creation_date	string (date-time)	Creation date (wire: creationDate)
customer	string	customer ID
dedicatedfiber_request	boolean	Check for Dedicated Fiber FTTO/FTTE eligibility ? (wire: dedicatedfiberRequest)
profiber_request	boolean	Check for Pro Fiber FTTH eligibility ? (wire: profiberRequest)
reference	string	Reference
reference_type	string	Reference type (address, building) (wire: referenceType)
updated_date	string (date-time)	Updated date (wire: updatedDate)

list

Eligibility recall

Name	Datatype	Description
id	integer	ID
completed	boolean	Is the recall completed ?
completed_date	string (date-time)	Completed date (wire: completedDate)
creation_date	string (date-time)	Creation date (wire: creationDate)
customer	string	customer ID
dedicatedfiber_request	boolean	Check for Dedicated Fiber FTTO/FTTE eligibility ? (wire: dedicatedfiberRequest)
profiber_request	boolean	Check for Pro Fiber FTTH eligibility ? (wire: profiberRequest)
reference	string	Reference
reference_type	string	Reference type (address, building) (wire: referenceType)
updated_date	string (date-time)	Updated date (wire: updatedDate)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Returns an eligibility recall: its address or building reference, the fiber offers it checks (Pro Fiber FTTH, Dedicated Fiber FTTO/FTTE), and its creation, update and completion dates.
list	select			Returns the eligibility recalls of the account, with their address or building reference, the requested fiber offers and whether each one is completed.
create	insert	reference, reference_type		Creates a recall on an address or building reference, to check again its eligibility to Pro Fiber FTTH or Dedicated Fiber FTTO/FTTE. Returns the created recall.
update	update	id, reference, reference_type		Updates the reference and the fiber offers to check of an eligibility recall. Returns the updated recall.
delete	delete	id		Deletes the eligibility recall of an address or building reference.

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

SELECT examples

get

Returns an eligibility recall: its address or building reference, the fiber offers it checks (Pro Fiber FTTH, Dedicated Fiber FTTO/FTTE), and its creation, update and completion dates.

SELECT
id,
completed,
completed_date,
creation_date,
customer,
dedicatedfiber_request,
profiber_request,
reference,
reference_type,
updated_date
FROM ovh.connectivity.eligibility_recalls
WHERE id = '{{ id }}' -- required
;

list

Returns the eligibility recalls of the account, with their address or building reference, the requested fiber offers and whether each one is completed.

SELECT
id,
completed,
completed_date,
creation_date,
customer,
dedicatedfiber_request,
profiber_request,
reference,
reference_type,
updated_date
FROM ovh.connectivity.eligibility_recalls
;

INSERT examples

create

Creates a recall on an address or building reference, to check again its eligibility to Pro Fiber FTTH or Dedicated Fiber FTTO/FTTE. Returns the created recall.

INSERT INTO ovh.connectivity.eligibility_recalls (
dedicatedfiber_request,
profiber_request,
reference,
reference_type
)
SELECT 
{{ dedicatedfiber_request }},
{{ profiber_request }},
'{{ reference }}' /* required */,
'{{ reference_type }}' /* required */
RETURNING
id,
completed,
completed_date,
creation_date,
customer,
dedicatedfiber_request,
profiber_request,
reference,
reference_type,
updated_date
;

Manifest

# Description fields are for documentation purposes
- name: eligibility_recalls
props:
  - name: dedicatedfiber_request
    value: {{ dedicatedfiber_request }}
    description: |
      Check for Dedicated Fiber FTTO/FTTE eligibility ?
  - name: profiber_request
    value: {{ profiber_request }}
    description: |
      Check for Pro Fiber FTTH eligibility ?
  - name: reference
    value: "{{ reference }}"
    description: |
      Reference
  - name: reference_type
    value: "{{ reference_type }}"
    description: |
      Reference type
    valid_values: ['address', 'building']

UPDATE examples

update

Updates the reference and the fiber offers to check of an eligibility recall. Returns the updated recall.

UPDATE ovh.connectivity.eligibility_recalls
SET 
dedicatedfiber_request = {{ dedicatedfiber_request }},
profiber_request = {{ profiber_request }},
reference = '{{ reference }}',
reference_type = '{{ reference_type }}'
WHERE 
id = '{{ id }}' --required
AND reference = '{{ reference }}' --required
AND reference_type = '{{ reference_type }}' --required
RETURNING
id,
completed,
completed_date,
creation_date,
customer,
dedicatedfiber_request,
profiber_request,
reference,
reference_type,
updated_date;

DELETE examples

delete

Deletes the eligibility recall of an address or building reference.

DELETE FROM ovh.connectivity.eligibility_recalls
WHERE id = '{{ id }}' --required
;