# List Data Source Metadata

Provides metadata on external data sources such as legal forms, address data, or legal entity data. Results are  paged by optional query parameters and filtered by additional parameters such as country short name or concepts  provided by the particular data source.


Endpoint: GET /v3/datasources
Version: 5
Security: apiKey

## Query parameters:

  - `countryShortName` (string)
    Country short name, i.e., the 2-digit ISO code.
    Example: "CH"

  - `managedConceptTechnicalKey` (string)
    Technical key of a CDQ data model concept.
    Example: "LEGAL_FORM"

  - `aleiPrefix` (string)
    Prefix of the database name, according to ALEI standard.
    Example: "DE.RC"

  - `technicalKey` (string)
    Technical key.
    Example: "DE_RC"

  - `implementationStatus` (string)
    DEPRECATED, use 'releaseStatus' instead.
    Example: "ACTIVE"

  - `releaseStatus` (array)
    See https://meta.cdq.com/Property:Release_status for semantics. According to CDLD-22386 list of 4,5,6,7,  corresponds to active data sources
    Example: ["4,5,6,7"]

  - `primaryInCountry` (string)
    ISO code of a country this data source is used in as a primary data source for compiling golden records.
    Example: "CH"

  - `preferredInCountry` (string)
    ISO code of a country this data source is used in as a preferred data source for compiling golden records.
    Example: "CH"

  - `unallowedInCountry` (string)
    ISO code of a country this data source is not allowed to be used in for compiling golden records.
    Example: "CH"

## Response 200 fields (application/json):

  - `pageSize` (integer)
    < The size of the provided page, as specified in the request, or by the default value.
    Example: "10"

  - `page` (integer)
    < The number of the page, as specified in the request, or '0' as default.
    Example: "1"

  - `total` (integer)
    < Total number of elements across all pages.
    Example: "100"

  - `values` (array)
    List of data source metadata.

  - `values.url` (string)
    URL of the data source.
    Example: "https://meta.cdq.com/Data_source/VIES"

  - `values.aleiPrefix` (string)
    Prefix of the database name, according to ALEI standard.
    Example: "VIES"

  - `values.technicalKey` (string)
    Technical key of the data source.
    Example: "VIES"

  - `values.shortName` (string)
    Short name of the data source.
    Example: "VIES"

  - `values.fullName` (string)
    English name of a concept.
    Example: "VAT Information Exchange System"

  - `values.localName` (string)
    Local name of the data source.
    Example: "VAT Information Exchange System"

  - `values.shortDescription` (string)
    Short description of the data source.
    Example: "Official interface to the European MIAS database."

  - `values.businessRegistryCode` (string)
    Business registry code of the data source.
    Example: "RA000274"

  - `values.countryScope` (string)
    DEPRECATED, please use 'countryScopeList' instead.
    Example: "CH"

  - `values.countryScopeList` (array)
    List of country short names.
    Example: ["CH"]

  - `values.managedConceptTechnicalKeys` (array)
    List of managed concept technical keys.
    Example: ["ADDRESS"]

  - `values.managedIdentifierTypes` (array)
    List of managed identifier types.
    Example: ["CH_VAT_ID"]

  - `values.categories` (array)
    List of categories.
    Example: ["VAT"]

  - `values.implementationStatus` (string)
    DEPRECATED, please use 'releaseStatus' instead.
    Example: "N/A"

  - `values.releaseStatus` (integer)
    https://meta.cdq.com/Property:Release_status for semantics.
    Example: "1"

  - `values.dataOwnership` (string)
    Data ownership of the data source.
    Example: "GOVERNMENTAL"

  - `values.dataProvision` (string)
    The data provision of the data source.
    Example: "OPEN"

  - `values.termsType` (string)
    Type of terms for the data source.
    Example: "EU_PUBLIC"

  - `values.numberOfRecords` (integer)
    Count the number of company records available in the data source, see https://meta.cdq.com/Property:Has_number_of_records
    Example: "50000000"

  - `values.provider` (string)
    Provider or authority of a data source, see https://meta.cdq.com/Property:Has_provider
    Example: "European Commission"

  - `values.licenceUrl` (string)
    URL that provides information on the license of the target see https://meta.cdq.com/Property:Has_licence_URL
    Example: "https://eur-lex.europa.eu/eli/dec/2011/833/oj"

  - `values.credentialTypes` (array)
    List of credential types, by their technical keys, see Type of single credential value.
Possible values:        *
    Example: ["USERNAME"]