directory_get_directory_service_codes

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

Overview

Name	directory_get_directory_service_codes
Type	Resource
Id	ovh.freefax.directory_get_directory_service_codes

Fields

The following fields are returned by SELECT queries:

list

Directory information

Name	Datatype	Description
ape_code	string	(wire: apeCode)
ape_description	string	(wire: apeDescription)
directory_service_code	integer	(wire: directoryServiceCode)
directory_service_description	string	(wire: directoryServiceDescription)
notification	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	ape_code, service_name		Get directory service code from an APE code (principal activity of the firm code)

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

SELECT examples

list

Get directory service code from an APE code (principal activity of the firm code)

SELECT
ape_code,
ape_description,
directory_service_code,
directory_service_description,
notification
FROM ovh.freefax.directory_get_directory_service_codes
WHERE ape_code = '{{ ape_code }}' -- required
AND service_name = '{{ service_name }}' -- required
;