Klantinteracties

F4936 - Zoek betrokkeneBijKlantcontact

Functionaliteit

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

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

API-calls voor het zoeken van het betrokkeneBijKlantcontact via eigenschappen van gerelateerde objecten

  • Zoeken met eigenschappen van de digitaalAdres (Zie F6634 - Zoek digitaal adres)
    • voorbeeld: get ../digitaleadressen?adres=Jan.Janssen@VNG.nl
    • deze call kan meerdere dititaleAdressen retourneren
    • op basis van de waarde die van de property verstrektDoorBetrokke die als onderdeel van een digitaalAdres wordt geretourneerd, kan de betrokkeneBijKlantcontact middels [F5859 - Vraag betrokkene bij klantcontact op] worden opgevraagd(./5859.md)
  • Zoeken met eigenschappen van de partij (Zie F7927 - Zoek partij)
    • voorbeeld: get ../partijen?achternaam=Janssen
    • deze call kan meerdere partijen retourneren.
    • met de waarde die in de property id die als onderdeel van een partij wordt geretourneerd, kunnen op basis van de property wasPartij betrokkenenBijKlantcontact worden gezocht.
    • voorbeeld: get ../betrokkenenBijKlantcontact?wasPartij=e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2
    • deze call kan meerdere betrokkenenBijKlantcontact retourneren.

API-call voor het zoeken op basis van eigenschappen van het klantcontact

  • Zoeken met eigenschappen van de partij:
    • get ../betrokkenenBijKlantcontact?wasPartij=e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2 of
    • get ../betrokkenenBijKlantcontact?achternaam=Janssen

Response bij het zoeken op basis van eigenschappen van het klantcontact

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

Objecttype - Attribuut Voorbeeld waarde Toelichting
BetrokkeneBijKlantcontact    
- id 5452f450-e940-4996-a353-37f4a7ec8710 Automatisch ingevuld door provider
- contactnaam    
   - achternaam Vries  
   - voorletters J  
   - voornaam Jan  
   - voorvoegselAchternaam de  
- bezoekadres    
   - adresregel1 van Puffelenstraat 14  
   - adresregel2 3255CD Turfstad  
   - adresregel3   Indien leeg zou deze niet opgenomen hoeven te zijn in de response
&nbsp  - codeLand 003  
   - nummeraanduidingid    
- correspondentieadres    
   - adresregel1    
   - adresregel2    
   - adresregel3   Indien leeg zou deze niet opgenomen hoeven te zijn in de response
   - codeLand    
   - nummeraanduidingid 3024045390642408  
   - rol klant  
   - initiator true  
   - organisatienaam   Indien leeg zou deze niet opgenomen hoeven te zijn in de response
   - hadKlantcontact 5452f450-e940-4996-a353-37f4a7ec8710  
   - wasPartij e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2