F2173 - Registreer klantcontact

Inleiding

Hoe het klantcontact wordt geregistreerd hangt samen met de wijze van het toekennen van de ID’s. Dit vraagstuk staat beschreven in V6577

In de kolom ‘toelichting’ van de tabellen hieronder wordt, behalve voor de ID’s, steeds een suggestie gegeven over de (mogelijke) herkomst van gegevens. Die gelden niet als voorschrift. Vooralsnog gaan we ervan uit dat ID’s worden toegekend door de provider.

Functionaliteit

De functie registreert een nieuw klantcontact inclusief van de bijbehorende verplicht gerelateerde objecten:

  • minimaal 1 betrokkeneBijKlantcontact
  • minimaal 1 actorKlantcontact

Aangezien de actorKlantcontact en betrokkeneBijKlantcontact pas kunnen worden vastgelegd als de id van het klantcontact bekend is, is er niet te ontkomen aan tijdelijke inconsistentie. Met de huidige wijze van toekennen van ID’s (door de provider) zal eerst het klantcontact vastgelegd moeten worden voordat actorKlantcontact en betrokkeneBijKlantcontact kunnen worden vastgelegd met de verwijzing naar het klantcontact.

Een klantcontact kan functioneel niet bestaan zonder dat er een gerelateerde actorKlantcontact en betrokkeneBijKlantcontact bestaan. Zolang de actorKlantcontact (met het juiste klantcontactId) en de betrokkeneBijKlantcontact (met de juiste hadKlantcontact) is er sprake van een inconsistentie.

Vastleggen klantcontact

API-call

post ../klantcontacten

Requestbody

| Objecttype - Attribuut | Voorbeeld waarde | Toelichting | | :———– | :———– | :———– | | Klantcontact | | | | - nummer | 23009182 | Automatisch toegekend door consumer, controle op uniciteit door de provider | | - codeKanaal | Telefoon | Prefill door consumer wijzigbaar door gebruiker | | - onderwerp | Afvalinzameling rond kerst | Handmatig ingevoerd door gebruiker consumer | | - 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. | Handmatig ingevoerd door gebruiker consumer | | - initiator | Klant | Prefill door consumer wijzigbaar door gebruiker | | - indicatieContactGelukt | Ja | Prefill door consumer wijzigbaar door gebruiker | | - codeTaal | ‘Nederlands | Prefill door consumer wijzigbaar door gebruiker | | - vertrouwelijk | Nee | Prefill door consumer wijzigbaar door gebruiker | | - plaatsgevondenOp` | 01-03-2023 10:00 | Prefill door consumer wijzigbaar door gebruiker |

Responsebody

| Objecttype - Attribuut | Voorbeeld waarde | Toelichting | | :———– | :———– | :———– | | Klantcontact | | | | - id | 5452f450-e940-4996-a353-37f4a7ec8710 | Automatisch toegekend door provider | | - 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 | |

Vastleggen actorKlantcontact

Uitgangspunt bij het vastleggen van de relatie tussen het klantcontact en de actor is dat de consumer-applicatie weet welke actor betrokken is bij het klantcontact doordat de medewerker is ingelogd. Deze actor wordt zonder tussenkomst van de gebruiker aan het klantcontact gekoppeld door de consumer-applicatie. Daarvoor is het nodig dat de id van de medewerker als actor bekend is in de consumerapplicatie.

Mochten er meer medewerkers bij een klantcontact betrokken zijn, bijvoorbeeld bij een gesprek, dan kunnen die actoren handmatig in de consumer-applicatie geselecteerd worden om ook vastgelegd tw worden. Het vastleggen van deze aanvullende medewerkers als actor gebeurt via de functie F6542 - Koppel Actor aan Klantcontact.

API-Call

post ../actorKlantcontacten

Requestbody

Objecttype - Attribuut Voorbeeld waarde Toelichting
ActorKlantcontact    
- actorId 49b22823-2465-4b7e-9bae-cbc7cddcfda4 Automatisch ingevuld door consumer, op basis van ingelogde gebruiker
- klantcontactId 5452f450-e940-4996-a353-37f4a7ec8710 Automatisch ingevuld door consumer, op basis van reseponse bij ‘vastleggen klantcontact’

Responsebody

Objecttype - Attribuut Voorbeeld waarde Toelichting
ActorKlantcontact    
- id 5452f450-e940-4996-a353-37f4a7ec8710 Automatisch toegekend door provider
- actorId 49b22823-2465-4b7e-9bae-cbc7cddcfda4  
- klantcontactId 5452f450-e940-4996-a353-37f4a7ec8710  

Vastleggen betrokkeneBijKlantcontact

Het vastleggen van de betrokkeneBijKlantcontact kan in een aantal scenario’s gebeuren.

  • Indien sprake is van contact met een reeds gekende partij:
    • Wordt er een betrokkeneBijKlantcontact vastgelegd waarin, naast specifieke gegevens van de betrokkenheid, de relatie tussen het klantcontact naar deze partij wordt vastgelegd.
    • Indien gewenst worden (contact-)gegevens die afwijken van de (contact-)gegevens zoals die in de partij opgenomen zijn vastgelegd in de betrokkeneBijKlantcontact om gebruikt te worden bij eventuele vervolg-contacten die de gemeente naar aanleiding van dit klantcontact heeft.
  • Indien geen sprake is van contact met een reeds gekende partij:
    • Als kan worden voldaan aan de voorwaarden voor het registeren van een partij, wordt met de aangeleverde gegevens een partij aangemaakt conform F5444 - Registreer partij en wordt er vervolgens een betrokkeneBijKlantcontact vastgelegd waarin, naast specifieke gegevens van de betrokkenheid, de relatie tussen het klantcontact naar deze partij wordt vastgelegd. Mochten er meer betrokkenen zijn bij een klantcontact betrokken zijn, bijvoorbeeld bij een gesprek, dan kunnen vastgelegd worden met de functie F2599 - Registreer betrokkene bij klantcontact.

Requestbody

Objecttype - Attribuut Voorbeeld waarde Toelichting
betrokkeneBijKlantcontact    
- contactnaam    
   - achternaam Vries Handmatig ingevoerd door gebruiker consumer
   - voorletters J Handmatig ingevoerd door gebruiker consumer
   - voornaam Jan Handmatig ingevoerd door gebruiker consumer
   - voorvoegselAchternaam de Handmatig ingevoerd door gebruiker consumer
- bezoekadres    
   - adresregel1 Van Puffelenstraat 12 Handmatig ingevoerd door gebruiker consumer
   - adresregel2 3219 FC Turfstad Handmatig ingevoerd door gebruiker consumer
   - adresregel3   Indien een niet-required property leeg is hoeft deze niet meegeleverd te worden.
   - codeLand 003 Prefill door gebruiker consumer
   - nummeraanduidingid 0518200000637599 Handmatig ingevoerd door gebruiker consumer
- correspondentieadres    
   - adresregel1 Postbus 2700 Handmatig ingevoerd door gebruiker consumer
   - adresregel2 3200 TD Turfstad Handmatig ingevoerd door gebruiker consumer
   - adresregel3   Indien een niet-required property leeg is hoeft deze niet meegeleverd te worden.
   - codeLand 003 Selectie door gebruiker consumer
   - nummeraanduidingid   Indien een niet-required property leeg is hoeft deze niet meegeleverd te worden.
- rol vertegenwoordiger Selectie door gebruiker consumer
- initiator true Selectie door gebruiker consumer
- organisatienaam Wereldwinkel ‘t kikkertje Handmatig ingevoerd door gebruiker consumer
- hadKlantcontact 5452f450-e940-4996-a353-37f4a7ec8710 Automatisch ingevuld door consumer, op basis van reseponse bij ‘vastleggen klantcontact’
- wasPartij e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2 Automatisch ingevuld door consumer, op basis van reseponse bij ‘zoek partij’

Responsebody

Objecttype - Attribuut Voorbeeld waarde Toelichting
betrokkeneBijKlantcontact    
- id fd36a205-8f20-4a1a-acd1-11a6ef8c56a4 Automatisch toegekend door provider
- contactnaam    
   - achternaam Vries  
   - voorletters J  
   - voornaam Jan  
   - voorvoegselAchternaam de  
- bezoekadres    
   - adresregel1 Van Puffelenstraat 12  
   - adresregel2 3219 FC Turfstad  
   - adresregel3    
   - codeLand 003  
   - nummeraanduidingid 0518200000637599  
- correspondentieadres    
   - adresregel1 Postbus 2700  
   - adresregel2 3200 TD Turfstad  
   - adresregel3    
   - codeLand 003  
   - nummeraanduidingid    
- rol vertegenwoordiger  
- initiator true  
- organisatienaam Wereldwinkel ‘t kikkertje  
- hadKlantcontact 5452f450-e940-4996-a353-37f4a7ec8710  
- wasPartij e8203b1b-f9e1-4fa1-96ce-2bcf36e061c2  

Optionele gerelateerde objecten

Naast de verplicht vast te leggen gerelateerde objecten, is er ook een aantal gerelateerde objecten dat optioneel kan worden geregistreerd. Het vastleggen hiervan wordt in aparte functies beschreven.

Gerelateerd object Functie Functionele toelichting
Interne taak F2120 - Registreer interne taak Indien opvoling van het klantcontact een vervolghandeling door een collega vereist
Onderwerpobject F9322 - Registreer onderwerpobject Indien er naast de onderwerptekst ook sprake is een verwijzing is naar een digitaal object als onderwerp zoals een zaak of een ander klantcontact
Bijlage F1975 - Registreer bijlage Indien er naast een eventuele inhoudstekst (ook) sprake is van een bijlage in de vorm van een digitaal vastgelegd object zoals een document (informatieobject) of een overig object (zoals de output van een e-formulier in JSON formaat)
Digitaal adres F1995 - Registreer Digitaal adres Indien er voor de betrokkeneBijKlantcontact een DigitaalAdres wordt opgegeven om te gebruiken voor het contact opnemen naar aanleiding van dit klantcontact
Partij F7554 - Registreer partij Indien de klant of vertegenwordiger is geauthenticeerd, maar de klant of vertegenwoordiger was niet bekend als partij dan wordt er een partij geregistreerd

Saga (foutafhandeling) Zie B8786.

  • Indien het vastleggen van de klantcontact door de provider niet lukt wordt er een response geleverd met een relevante HTTP-foutcode en een zo accuraat mogelijke toelichting van het opgetreden probleem. Er zijn dan geen gegevens vastgelegd.

  • Indien de partij wel is vastgelegd (en er dus een responsecode ‘201’ met responsebody is ontvangen), maar de actorKlantcontact of de betrokkeneBijKlantcontact niet kunnen worden vastgelegd door de provider dient de consumer zelf de zojuist aangemaakte partij te verwijderen en de eventueel aangemaakte actorKlantcontact of betrokkeneBijKlantcontact die is aangemaakt te verwijderen.