Intro Documentatie & testen Swagger Terminologie ClientID Access Token Webhooks Postman Problemen oplossen Best practices Datamodel FAQ Releasenotes Use cases


In dit artikel vind je een aantal tips om op een efficiënte wijze data m.b.v. de API uit Coachview te ontsluiten of data aan te bieden.

Ophalen data:
Alleen nieuwe en gewijzigde data ophalen.

Filteren op 'gewijzigddatumtijd' haalt records op die binnen de opgegeven periode aangemaakt of gewijzigd zijn.		Alle records die gisteren zijn gemaakt:
GET ../Aanvragen?where=audittrail.gewijzigddatumtijd=09-06-2021,10-06-2021
Filters optimaal gebruiken.Indien nodig dan filteren op meerdere id's tegelijkertijd:
GET ../Orderverkoopregels?where=aanvraagid={id},{id},{id}
Slimme foutafhandeling, dus niet 100 keer opnieuw proberen.

Veelvoorkomende statuscodes zijn:
  1. 401: geen toegang, waarschijnlijk geen geldig access token. Vraag een nieuw token aan.
  2. 403: niet geauthoriseerd, waarschijnlijk niet de juiste scopes ingesteld. Controleer de scopes en de rechten.
  3. 429: limiet van aantal requests bereikt. Pas opnieuw request doen wanneer limiet gereset is.
  4. 500: internal server error. Mogelijk een time-out. Meest voorkomende oorzaak is een te hoge SKIP. Voorkeur gaat uit naar een filter op datum in plaats van een loop met behulp van SKIP en TAKE. In geval van error 500 contact opnemen met Coachview.

Bij een automatisch proces kan het altijd voorkomen dat de API tijdelijk niet bereikbaar is. Zorg ervoor dat je bij bouwen van de koppeling hier rekening mee houdt. Denk bijvoorbeeld aan het opslaan van webaanvragen indien de webaanvraag niet succesvol verstuurd kan worden. 

Webaavraag toevoegen (post):

Contactpersoon/deelnemer(s):
Er zijn verschillende situaties mogelijk waarbij persoonsgegevens vastgelegd moeten worden. Het is belangrijk om te weten hoe je een contactpersoon en deelnemers vastgelegd moeten worden. Daarbij is het van belang of de contactpersoon tevens deelnemer is.
A. Deelnemer schrijft zich zelf in:
  • Alleen 'contactpersoon' invullen.
B. Contactpersoon schrijft medewerker(s) in:
  • Gegevens contactpersoon vastleggen in 'contactpersoon' 
  • Van de medewerkers in 'deelnemers'.
C. Contactpersoon schrijft zichzelf en medewerkers in:
  • Gegevens contactpersoon vastleggen in 'contactpersoon' 
  • Van de medewerkers in 'deelnemers'.
  • Gegevens contactpersoon ook vastleggen in 'deelnemers'.


Debeiteurgegevens:
Er zijn verschillende situaties mogelijk hoe de debiteur te bepalen.
A. Bedrijf wordt meegestuurd en is debiteur:
  • Gegevens 'bedrijf' invullen
  • Geen 'debiteur' gegevens vastleggen.
B. Contactpersoon wordt meegestuurd en is debiteur:
  • Gegevens contactpersoon vastleggen in 'contactpersoon' 
  • En 'particulier' = true vastleggen in 'debiteur'.
C. Contactpersoon wordt meegestuurd en bedrijf bij contactpersoon is debiteur:
  • Gegevens contactpersoon vastleggen in 'contactpersoon' 
  • Geen 'debiteur' gegevens vastleggen.
D. Debiteur wordt expliciet meegestuurd:
  • Gegevens debiteur vastleggen in 'debiteur'.


Tip: Processen uitdenken? We denken graag met je mee [email protected].


Let op: op dit moment kun je in de live-omgeving met Swagger niet testen.


Bijgewerkt tot en met versie 93