Intro Releasenotes Documentatie & testen ClientID Access Token Webhooks Postman Best practices Unauthorized(401) Forbidden(403) Limiet Bereikt (429) Meldingen FAQ Terminologie Use case: bijwerken persoon Use case: niet beschikbaarheid Use case: aanbod op website Use case: inschrijving versturen  Datamodel


Personen in Coachview worden via de API 'Personen ->POST' aangemaakt op het moment dat ze 'geboren' worden in een andere applicatie. Denk hierbij aan bijvoorbeeld een HR-systeem. Hierbij wordt vanwege AVG minimale informatie meegestuurd. Echter voor het maken en versturen van een diploma dient de geboortedatum en geboorteplaats bekend te zijn. Alleen wanneer een persoon deelneemt aan een opleiding dienen deze gegevens toegevoegd te worden.

Stappenplan:
1.Piet Pietersen wordt 'geboren' in het HR systeem en wordt via API 'Personen -> POST' aangemaakt in Coachview zonder geboortedatum en geboorteplaats.
2.Piet schrijft wordt ingeschreven in een opleiding waarvoor een diploma inclusief geboortedatum en geboorteplaats wordt uitgereikt.
3.Bij inschrijving wordt een actie gestempeld die uitgevoerd wordt als Piet slaagt en die ervoor zorgt dat persoonscategorie 'Extragegevens' wordt toegevoegd aan het persoonsdossier van Piet. 
4.Het toevoegen van deze persoonscategorie triggert een webhook die een bericht naar het HR-systeem stuurt.
5.Dit zorgt ervoor dat in het persoonsdossier van Piet de geboortedatum en geboorteplaats vanuit het HR-s worden toegevoegd.
Wil je testen? Dan kan dat via onze documentatie pagina (Swagger). Let op: nu alleen nog maar via de trainingsomgeving van Coachview. Klik hier voor de documentatie pagina van de trainingsomgeving van Coachview.

Onderstaand voorbeeld is tot stand gekomen met behulp van deze documentatie pagina.

Webhook:
De webhook 'persoon.categorie.toegevoegd' wordt getriggerd met de volgende gegevens.
  1. PersoonId: publicId van Coachview die de persoon identificeert.
  2. PersooncategorieId: publicid van Coachview die de persoonscategorie identificeert.
  3. ExternId / Externsource: unieke identifier van het HR-systeem, bijvoorbeeld het personeelsnummer en de naam van de applicatie.
  4. Categorie: de naam van de categorie.

API:
Voor het toevoegen van de geboortedatum en geboorteplaats gebruik je de API 'Personen' met als request de PUT 'Een persoon wijzigen'.
Let op: de persoon dient volledig te worden aangeleverd. Alle elementen moeten dus, voor zover bekend, ingevuld worden. Haal de persoon dus eerst op via publicid of externid/externsource of uit jouw gekoppelde applicatie. Laat je een element leeg maar is deze in Coachview wel ingevuld? Dan wordt het gegeven in Coachview gewist. 
  1. PublicID van persoonsdossier Pieter.
  2. Elementen (gegevens) die je meegeeft en die er voor zorgen dat alleen deze gegevens gewijzigd worden. Let op: je moet alle elementen, voor zover bekend, invullen. Dus niet alleen de elementen die je op het plaatje ziet. Laat je een element leeg maar is deze in Coachview wel ingevuld? Dan wordt het gegeven in Coachview gewist.
  3. Uitvoeren van het request.


Bijgewerkt tot en met versie 85