Maak je geen gebruik van een opleidingsportaal van Coachview, maar heb je een eigen website of applicatie waarmee je inschrijvingen door wilt sturen naar Coachview? Dan vind je hieronder informatie over de mogelijkheden van onze API m.b.t. webaanvragen.

Welke endpoints zijn er?
  • GET Webaanvragen: Hiermee haal je de informatie van één of meerdere webaanvragen op. De webaanvraag bevat naast algemene informatie ook informatie over o.a. de contactpersoon, het bedrijf en de debiteur.

  • GET WebaanvraagOpleidingen: Hiermee haal je de informatie van één of meerdere opleidingen op waarop via de gekoppelde webaanvraag is ingeschreven. De response bestaat o.a. uit de code, de naam en het id van de gekoppelde webaanvraag, opleiding en/of opleidingssoort.

  • GET WebaanvraagDeelnemers: Hiermee haal je de informatie van één of meerdere deelnemers op die via de gekoppelde webaanvraag zijn ingeschreven.

    LET OP: De contactpersoon van de webaanvraag kan ook een deelnemer zijn. Mogelijke scenarios:
    Een persoon schrijft alleen zichzelf in:
    - Webaanvraag.aantalDeelnemers is 1
    - Webaanvraag.contactpersoonIsDeelnemer is true
    - WebaanvraagDeelnemers bevat geen deelnemers

    Een persoon schrijft zichzelf én 2 anderen in:
    - Webaanvraag.aantalDeelnemers is 3
    - Webaanvraag.contactpersoonIsDeelnemer is true
    - WebaanvraagDeelnemers bevat 2 deelnemers

    Een persoon schrijft alleen 2 anderen in:
    - Webaanvraag.aantalDeelnemers is 2
    - Webaanvraag.contactpersoonIsDeelnemer is false
    - WebaanvraagDeelnemers bevat 2 deelnemers

    Om te weten hoeveel deelnemers een webaanvraag heeft, kun je dus het beste kijken naar het veld AantalDeelnemers van de Webaanvraag.

  • POST Webaanvragen: Hiermee stuur je de webaanvraag door naar Coachview. In de body van de request stuur je een JSON-object mee met de gegevens van de webaanvraag. Hieronder vind je enkele voorbeelden van een mogelijke webaanvraag.

Voorbeelden van webaanvragen
Hieronder staat met voorbeelden toegelicht hoe één of meerdere deelnemers ingeschreven kunnen worden. Om de voorbeelden zo eenvoudig mogelijk te houden zijn alleen de velden opgenomen die noodzakelijk zijn om het scenario duidelijk te beschrijven. Het is uiteraard mogelijk om meer velden door te sturen.

Een persoon schrijft alleen zichzelf in:

{
  "opmerking": "Een persoon schrijft alleen zichzelf in",
  "contactpersoon": {
    "voornaam": "Contact",
    "achternaam": "Persoon"
  }
}

Een persoon schrijft alleen anderen in:

{
  "opmerking": "Een persoon schrijft alleen anderen in",
  "contactpersoon": {
    "voornaam": "Contact",
    "achternaam": "Persoon"
  },
  "deelnemers": [
    {
        "voornaam": "Deel",
        "achternaam": "Nemer 1"
    },
    {
        "voornaam": "Deel",
        "achternaam": "Nemer 2"
    }
  ]
}

Een persoon schrijft zichzelf en anderen in:

{
  "opmerking": "Een persoon schrijft zichzelf en anderen in",
  "contactpersoon": {
    "voornaam": "Contact",
    "achternaam": "Persoon"
  },
  "deelnemers": [
    {
        "voornaam": "Contact",
        "achternaam": "Persoon"
    },
    {
        "voornaam": "Deel",
        "achternaam": "Nemer 1"
    },
    {
        "voornaam": "Deel",
        "achternaam": "Nemer 2"
    }
  ]
}