Klantinteracties

F7927 - Zoek partij

Functionaliteit

Deze functie retourneert alle partijen die aan de opgegeven zoekcriteria voldoen.

Hier is onderscheid te maken tussen zoekcriteria die gebaseerd zijn op de eigenschappen (properties) van de resource partij en eigenschappen van aan de partij gerelateerde objecten zoals partijidentificator en digitaal adres.

API-calls voor het zoeken van de partij via eigenschappen van gerelateerde objecten

  • Zoeken met eigenschappen van het digitaal Adres (Zie F6634)
    • get ../digitaaladressen?adres=jan.janssen@VNG.nl
    • Met de waarde van de property verstrektDoorPartij die als onderdeel van een digitaal adres wordt geretourneerd, kan de partij worden opgevraagd (Zie F0138):
  • Zoeken met eigenschappen van de partij-identificator (Zie F5817)
    • get ../partijidentificatoren?objectId=999990019&soortObjectId=burgerservicenummer
    • Met de waarde van de property identificeerdePartij die als onderdeel van een partijidentificator wordt geretourneerd, kan de partij worden opgevraagd (Zie F0138):

API-call voor het zoeken op basis van eigenschappen van de partij

Voorbeelden van zoeken bij een REST/Json API in CRUD-vorm:

  • Zoeken met eigenschappen van de Partij:
    • get ../partijen/?nummer=123454321 of
    • get ../partijen/?bezoekadres.postcode=2345CD&bezoekadres.huisnummer=11

Indien het wenselijk is dat er gezocht wordt naar ingeschreven natuurlijk personen in de Basisregistratie Personen of naar ingeschreven niet-natuurlijk personen in het Handelsregister, dan worden eerst de betreffende basisregistraties bevraagd met de daarvoor beschikbare middelen.

Vervolgens kan de bijbehorende partij (of partijen) in het klantinteractiesregister opgehaald worden met behulp van “Zoeken met eigenschappen van de partijIdentificator”.

Vanuit privacy-overwegingen is het niet gewenst dat partijen op basis van willekeurige zoekcriteria gezocht kunnen worden (V2703 - Als er bij stakeholders geen consensus is, werken we dan meerdere alternatieven uit?).

Het lijkt in ieder geval goed om te kijken of er formele criteria zijn voor hoe personen geauthentiseerd kunnen worden zonder een middel als DigiD/eIDAS (V6881 - Criteria voor niet digitale authenticatie?).

Response bij het zoeken op basis van eigenschappen van de partij

De response wordt inhoudelijk beschreven. Houd er rekening mee dat het zoeken op een eigenschap van de partij kan resulteren in meerdere partijen in de response.

Objecttype - Attribuut Voorbeeld waarde Toelichting
Partij    
- ID e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2  
- Nummer 123454321  
- Bezoekadres    
   - NummeraanduidingID    
   - Adresregel 1 Van Puffelenstraat 23  
   - Adresregel 2 9823 SG Tietjerkstradeel  
   - Adresregel 3    
   - Land Nederland  
- Correspondentieadres    
   - NummeraanduidingID    
   - Adresregel 1 Janssenstraat 12  
   - Adresregel 2 9821 ST Tietjerkstradeel  
   - Adresregel 3    
   - Land Nederland  
- Interne Notitie    
- Soort partij persoon  
- Indicatie geheimhouding false  
- Voorkeurstaal ‘Nederlands’  
- Indicatie actief true  
- Voorkeurs digitaal adres 9cf03ac6-776c-42bc-a6ea-f6e3302a3b96