OSR:2019/Opvragen mandaten: verschil tussen versies

Uit Kennisnet Developers Documentatie
Ga naar: navigatie, zoeken
Regel 20: Regel 20:
 
</syntaxhighlight>
 
</syntaxhighlight>
   
  +
==Request parameters==
De Lijst kan leeg zijn als er geen match is gevonden.
 
  +
{|class="wikitable"
HTTP/1.1 200 OK wordt geretourneerd
 
  +
! style="text-align:left;"| Parameters
  +
! style="text-align:left;"| Omschrijving
  +
! style="text-align:left;"| Verplicht/Optioneel
  +
!
  +
|-
  +
| | Name
  +
| Naam van de onderwijsinstelling.
  +
| | Optioneel
  +
|-
  +
| | oin
  +
| Oin van de onderwijsinstelling
  +
| | Optioneel
  +
|-
  +
| | brin
  +
| Brin van de onderwijsinstelling
  +
| | Optioneel
  +
|-
  +
| | oa_id
  +
| Onderwijs aanbieder id van de onderwijsinstelling. Dit komt uit RIO
  +
| | Optioneel
  +
|}

Versie van 30 jan 2019 om 14:39

Het mandaat legt de relatie vast tussen onderwijsinstelling, dienst en een leverancier. Het mandaat zelf wordt aangemaakt door de OSR beheerder van de onderwijsinstelling via het zakelijk portaal.

Door het aanmaken van een mandaat is het mogelijk voor een leverancier om een endpoint aan te kunnen maken (of wijzigen) in het OSR.
Daarnaast is het mogelijk voor andere partijen om te verifiëren of een leverancier gemandateerd is namens een onderwijsinstelling voor een bepaalde dienst.

De opvraging van mandaten kan 2 mogelijke antwoorden teruggeven.

  • Voor de leverancier die zijn eigen mandaat opvraagt wordt er detail informatie teruggegeven over het mandaat.
  • Voor andere partijen die willen verifiëren of een bepaalde leverancier gemandateerd is, wordt alleen een OK of NOK teruggegeven.

Een mandaat heeft altijd een startdatum en mogelijk een einddatum.
Het kan dus zo zijn dat een mandaat in het verleden wel aanwezig was, maar inmiddels al is beëindigd.
Of een mandaat kan in de toekomst ingesteld zijn. Hiervoor is de reference_date parameter bedacht om een mandaat van het verleden of de toekomst op te vragen. 


Hieronder is een voorbeeld weergegeven van de request:

/api/v1/mandates?supplier_oin=00000003272448340204&school_oin=0000000700000AV00000&service_version_namespace=http://xml.eld.nl/schemas/Overstapservice/20180404&reference_date=2019-01-01

Request parameters

Parameters Omschrijving Verplicht/Optioneel
Name Naam van de onderwijsinstelling. Optioneel
oin Oin van de onderwijsinstelling Optioneel
brin Brin van de onderwijsinstelling Optioneel
oa_id Onderwijs aanbieder id van de onderwijsinstelling. Dit komt uit RIO Optioneel