Le modèle de données d'une party : identifiants, noms, localisations et exemples de requêtes.
Le VPD retourne les données de parties sous forme d'objet party. Cet article décrit la structure de cet objet, les paramètres de recherche disponibles et des exemples de requêtes que vous pouvez utiliser directement.
Chaque résultat du VPD suit la même structure. Vous trouverez ci-dessous tous les champs de l'objet party :
idtypepartyIdslegalNametradeNamessectorCodeslocationswebsiteLe champ partyIds contient une liste d'objets identifiants. Chaque identifiant possède un type (le schéma, par ex. KVK, OIN, VAT) et une value (le numéro lui-même). Une organisation peut avoir plusieurs identifiants.
Les localisations contiennent des informations d'adresse (rue, code postal, ville, pays) et éventuellement des coordonnées géographiques (latitude et longitude). Une organisation peut avoir plusieurs établissements.
Vous interrogez le VPD avec les paramètres de requête suivants :
idnamepostcodecitycountrysearchmaxResultsVous pouvez combiner les paramètres pour affiner votre recherche, par exemple nom et ville simultanément.
{
parties(name: "eConnect", country: "NL", maxResults: 5) {
id
legalName
tradeNames
partyIds {
type
value
}
}
}
{
parties(id: "12345678", maxResults: 1) {
id
legalName
locations {
street
postcode
city
country
latitude
longitude
}
website
}
}
{
parties(search: "facturatie Woerden", maxResults: 10) {
id
type
legalName
tradeNames
partyIds {
type
value
}
sectorCodes
locations {
street
postcode
city
country
}
website
}
}
Lors de la recherche via le VPD, il est utile de savoir que le paramètre search parcourt tous les champs, tandis que name et id sont plus ciblés. Utilisez name si vous connaissez le nom de l'entreprise (ou une partie), et id si vous disposez d'un identifiant exact. Combinez postcode ou city avec name si vous attendez plusieurs résultats et souhaitez filtrer par localisation.
Gardez à l'esprit que maxResults est défini par défaut à 10. Si vous souhaitez plus de résultats, indiquez une valeur plus élevée. Pour valider rapidement l'existence d'une organisation spécifique, maxResults: 1 avec un identifiant exact suffit.
Vous souhaitez tester des requêtes de manière interactive ? Utilisez le VPD Playground. Ou découvrez comment intégrer le VPD dans votre application.
Essayer le VPD Playground