directories

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

Overview

Name	directories
Type	Resource
Id	ovh.freefax.directories

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
name	string
display_first_name	boolean	(wire: displayFirstName)
first_name	string	(wire: firstName)
way_name	string	(wire: wayName)
address	string
address_extra	string	(wire: addressExtra)
ape	string
area_code	integer	(wire: areaCode)
birth_date	string (date)	(wire: birthDate)
cedex	string
city	string
country	string
directory_service_code	string	(wire: directoryServiceCode)
display_marketing_directory	boolean	(wire: displayMarketingDirectory)
display_only_city	boolean	(wire: displayOnlyCity)
display_search_reverse	boolean	(wire: displaySearchReverse)
display_universal_directory	boolean	(wire: displayUniversalDirectory)
email	string
gender	string	All genders a person can choose (female, male)
insee_code	integer	(wire: inseeCode)
legal_form	string	(wire: legalForm)
line_description	string	(wire: lineDescription)
modification_date	string	(wire: modificationDate)
modification_type	string	(wire: modificationType)
number	string
occupation	string
pj_social_nomination	string	(wire: PJSocialNomination)
post_box	string	(wire: postBox)
post_code	string	(wire: postCode)
receive_pj_directory	boolean	(wire: receivePJDirectory)
siret	string
social_nomination	string	(wire: socialNomination)
social_nomination_extra	string	(wire: socialNominationExtra)
status	string
urban_district	string	(wire: urbanDistrict)
way_number	string	(wire: wayNumber)
way_number_extra	string	(wire: wayNumberExtra)
way_type	string	(wire: wayType)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name		Get Freefax directory information
update	update	service_name		Edit Freefax directory information
fetch_entreprise_informations	exec	serviceName, entrepriseNumber		Get enterprise information by providing enterprise number

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"}})
serviceName	string (phone-number)	Service name
service_name	string (phone-number)	Service name (wire: serviceName)

SELECT examples

get

Get Freefax directory information

SELECT
name,
display_first_name,
first_name,
way_name,
address,
address_extra,
ape,
area_code,
birth_date,
cedex,
city,
country,
directory_service_code,
display_marketing_directory,
display_only_city,
display_search_reverse,
display_universal_directory,
email,
gender,
insee_code,
legal_form,
line_description,
modification_date,
modification_type,
number,
occupation,
pj_social_nomination,
post_box,
post_code,
receive_pj_directory,
siret,
social_nomination,
social_nomination_extra,
status,
urban_district,
way_number,
way_number_extra,
way_type
FROM ovh.freefax.directories
WHERE service_name = '{{ service_name }}' -- required
;

UPDATE examples

update

Edit Freefax directory information

UPDATE ovh.freefax.directories
SET 
pj_social_nomination = '{{ pj_social_nomination }}',
address = '{{ address }}',
address_extra = '{{ address_extra }}',
ape = '{{ ape }}',
birth_date = '{{ birth_date }}',
cedex = '{{ cedex }}',
city = '{{ city }}',
country = '{{ country }}',
directory_service_code = '{{ directory_service_code }}',
display_first_name = {{ display_first_name }},
display_marketing_directory = {{ display_marketing_directory }},
display_only_city = {{ display_only_city }},
display_search_reverse = {{ display_search_reverse }},
display_universal_directory = {{ display_universal_directory }},
email = '{{ email }}',
first_name = '{{ first_name }}',
gender = '{{ gender }}',
legal_form = '{{ legal_form }}',
line_description = '{{ line_description }}',
name = '{{ name }}',
occupation = '{{ occupation }}',
post_box = '{{ post_box }}',
post_code = '{{ post_code }}',
receive_pj_directory = {{ receive_pj_directory }},
siret = '{{ siret }}',
social_nomination = '{{ social_nomination }}',
social_nomination_extra = '{{ social_nomination_extra }}',
urban_district = '{{ urban_district }}',
way_name = '{{ way_name }}',
way_number = '{{ way_number }}',
way_number_extra = '{{ way_number_extra }}',
way_type = '{{ way_type }}'
WHERE 
service_name = '{{ service_name }}' --required;

Lifecycle Methods

EXEC variables use wire (API) names.

fetch_entreprise_informations

Get enterprise information by providing enterprise number

EXEC ovh.freefax.directories.fetch_entreprise_informations 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"entrepriseNumber": "{{ entrepriseNumber }}"
}'
;