Klantinteracties

F7927 - Zoek klantcontact

Functionaliteit

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

Hier is onderscheid te maken tussen zoekcriteria die gebaseerd zijn op de eigenschappen (properties) van de resource klantcontact, en eigenschappen van aan de klantcontact gerelateerde objecten zoals betrokkeneBijKlantcontact, partij (via betrokkenBijKlantcontact) of actor (via actorKlantcontact).

  • API-calls voor het zoeken van het klantcontact via eigenschappen van gerelateerde objecten

  • Zoeken met eigenschappen van de actor (Zie F5582 - Zoek actor)
    • voorbeeld: get ../actoren/naam=Nicole%20van%20Dijk
    • met de waarde van de property actorId die als onderdeel van een actor wordt geretourneerd, kunnen op basis van de property hadKlantcontact actorKlantcontacten worden gezocht.
    • get ../actorKlantcontacten?actorId=bcc1da57-64df-4d8e-b91e-90fbf7ae7200
    • deze call kan meerdere actorKlantcontacten retourneren.
    • voor ieder geretourneerd actorKlantcontact wordt op basis van de waarde van de property klantcontactId met functie F8618 - Vraag klantcontact op het bijbehorende klantcontact opgehaald.
  • Zoeken met eigenschappen van de betrokkeneBijKlantcontact (Zie F4936 - Zoek betrokkene bij klantcontact)
    • get ../betrokkenenBijKlantcontact?achternaam=Janssen
    • deze call kan meerdere betrokkenenBijKlantcontact retourneren.
    • voor ieder geretourneerd betrokkeneBijKlantcontact wordt op basis van de waarde van de property hadKlantcontact met functie F8618 - Vraag klantcontact op het bijbehorende klantcontact opgehaald.
  • Zoeken met eigenschappen van de partij (Zie F7927 - Zoek partij)
    • voorbeeld: get ../partijen/achternaam=Janssen
    • deze call kan meerdere partijen retourneren.
    • met de waarde van de property id die als onderdeel van een partij wordt geretourneerd, kunnen op basis van de property wasPartij betrokkenenBijKlantcontact (zie F4936 - Zoek betrokkene bij klantcontact) worden gezocht.
    • get ../betrokkenenBijKlantcontact?wasPartij=e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2
    • deze call kan meerdere betrokkenenBijKlantcontact retourneren.
    • voor iedere betrokkeneBijKlantcont wordt op basis van de waarde van de property hadKlantcontact het bijbehorende klantcontact opgehaald met de functie F8618 - Vraag klantcontact op

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

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

  • Zoeken met eigenschappen van de Partij:
    • get ../klantcontacten/?nummer=1234321 of
    • get ../klantcontacten/?kanaal=004

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 een klantcontact kan resulteren in meerdere klantcontacten in de response.

| Objecttype - Attribuut | Voorbeeld waarde | Toelichting | | :———– | :———– | :———– | | Klantcontact | | | | - id | 5452f450-e940-4996-a353-37f4a7ec8710 | | | - nummer | 23009182 | | | - codeKanaal | Telefoon | | | - onderwerp | Afvalinzameling rond kerst | | | - inhoud | Klant vraagt wanneer afval van klant wordt opgehaald. Normaal gesproken op maandag opgehaald. Dit jaar valt 1e kerstdag op maandag. Antwoord: Aangegeven dat het afval de zaterdag voorafgaand aan de maandag aangeboden kan worden. | | | - initiator | Klant | | | - indicatieContactGelukt | Ja | | | - codeTaal | ‘Nederlands | | | - vertrouwelijkheid | Nee | | | - plaatsgevondenOp` | 01-03-2023 10:00 | |