El modelo de datos de una party: identificadores, nombres, ubicaciones y consultas de ejemplo.
El VPD devuelve los datos de partes como un objeto party. Este artículo describe la estructura de ese objeto, los parámetros de búsqueda disponibles y consultas de ejemplo que puede utilizar directamente.
Cada resultado del VPD sigue la misma estructura. A continuación encontrará todos los campos del objeto party:
idtypepartyIdslegalNametradeNamessectorCodeslocationswebsiteEl campo partyIds contiene una lista de objetos identificadores. Cada identificador tiene un type (el esquema, por ej. KVK, OIN, VAT) y un value (el número en sí). Una organización puede tener múltiples identificadores.
Las ubicaciones contienen datos de dirección (calle, código postal, ciudad, país) y opcionalmente coordenadas geográficas (latitude y longitude). Una organización puede tener múltiples establecimientos.
Puede consultar el VPD con los siguientes parámetros de consulta:
idnamepostcodecitycountrysearchmaxResultsPuede combinar parámetros para refinar su búsqueda, por ejemplo nombre y ciudad simultáneamente.
{
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
}
}
Al buscar a través del VPD, es útil saber que el parámetro search recorre todos los campos, mientras que name e id son más específicos. Utilice name si conoce el nombre de la empresa (o una parte), e id si dispone de un identificador exacto. Combine postcode o city con name si espera múltiples resultados y desea filtrar por ubicación.
Tenga en cuenta que maxResults está configurado por defecto en 10. Si desea más resultados, indique un valor más alto. Para validar rápidamente la existencia de una organización específica, maxResults: 1 con un identificador exacto es suficiente.
¿Desea probar consultas de forma interactiva? Utilice el VPD Playground. O descubra cómo integrar el VPD en su aplicación.
Probar el VPD Playground