OSR:2019/toevoegen wijzigen endpoints: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
 
(11 tussenliggende versies door dezelfde gebruiker niet weergegeven)
Regel 17: Regel 17:
 
"mandate_token": "6a47bfdd-81a7-46cd-b41f-d907e91ebdfc",
 
"mandate_token": "6a47bfdd-81a7-46cd-b41f-d907e91ebdfc",
 
"administration_id": "0000000700004HR77707",
 
"administration_id": "0000000700004HR77707",
−
"service_version_namespace": “http://xml.eld.nl/schemas/Overstapservice/20170601",
+
"service_version_namespace": "http://xml.eld.nl/schemas/Overstapservice/20170601",
−
"url": https://t2.nl,
+
"url": "https://t2.nl",
  +
"attributes": "LAS",
−
“attributes”: “LAS”,
 
−
“start_date”: “2019-01-01”,
+
"start_date": "2019-01-01",
−
“end_date”: “2020-01-01”
+
"end_date": "2020-01-01"
 
}
 
}
  +
  +
Request Headers
  +
JWT:
  +
  +
eyJhbGciOiJSUz …
 
</syntaxhighlight>
  
</syntaxhighlight>
  +
  +
Op de volgende pagina kan nadere informatie omtrent JWT gevonden worden:
  +
[[OSR:2019/JWT|JWT]]
  +
  +
==Request parameters==
  +
{|class="wikitable"
  +
! style="text-align:left;"| Parameters
  +
! style="text-align:left;"| Omschrijving
  +
! style="text-align:left;"| Verplicht/Optioneel
  +
!
  +
|-
  +
| | mandate_token
  +
| Het mandaat token welke verkregen is door het mandaat op te vragen
  +
| | Verplicht
  +
|-
  +
| | administration_id
  +
| Uniek administratie kenmerk.<br>Dit moet goed afgestemd worden met de onderwijsinstelling, om eventuele problemen te voorkomen bij meerdere leveranciers die gemandateerd zijn voor de onderwijsinstelling en dienst combinatie.
  +
| | Verplicht
  +
|-
  +
| | service_version_namespace
  +
| Namespace van de dienst
  +
| | Verplicht
  +
|-
  +
| | url
  +
| Technische locatie van de leverancier
  +
| | Verplicht
  +
|-
  +
| | attributes
  +
| Mogelijke attributen die ook opgeslagen moeten worden bij dit endpoint
  +
| | Optioneel
  +
|-
  +
| | start_date*
  +
| Start datum van het endpoint. <br>Indien dit niet meegegeven wordt, dan wordt de huidige datum hier automatisch ingevuld. start datum kan niet in het verleden liggen.
  +
| | Optioneel
  +
|-
  +
| | end_date*
  +
| Eind datum van het endpoint. Einddatum kan niet in het verleden liggen
  +
| | Optioneel
  +
|}
  +
  +
'''*start_date: middernacht aan het begin van de opgegeven datum<br>
  +
'''*end_date: middernacht aan het einde van de opgegeven dag
  +
  +
  +
 
 
  
 

Huidige versie van 30 jan 2019 om 15:24

De leverancier moet de informatie over het endpoint zelf aanleveren.
Dit wijkt af van het OSO-project, waar een school in eerste instantie het endpoint (aanleverpunt) aanmaakt en de leverancier vervolgens het afleveradres erbij opslaat middels de call registreer aanleverpunt.

Om een endpoint aan te maken of te modificeren moet de leverancier gemandateerd zijn en het mandaat token gebruiken in de aanvraag voor het aanmaken van het endpoint.
 

Endpoints zijn specifiek voor een dienstversie en er kan eventueel ook een ingangsdatum worden meegegeven.

Bij deze service moet er ook een JWT token worden meegegeven. In het volgende hoofdstuk wordt uitgelegd hoe JWT toegepast wordt voor OSR.


Hieronder is een voorbeeld weergegeven van de POST operatie:    /api/v1/endpoints

{ 
"mandate_token": "6a47bfdd-81a7-46cd-b41f-d907e91ebdfc", 
"administration_id": "0000000700004HR77707", 
"service_version_namespace": "http://xml.eld.nl/schemas/Overstapservice/20170601", 
"url": "https://t2.nl", 
"attributes": "LAS", 
"start_date": "2019-01-01", 
"end_date": "2020-01-01" 
} 

Request Headers 
JWT: 
 
eyJhbGciOiJSUz …

Op de volgende pagina kan nadere informatie omtrent JWT gevonden worden: JWT

Request parameters

Parameters Omschrijving Verplicht/Optioneel
mandate_token Het mandaat token welke verkregen is door het mandaat op te vragen Verplicht
administration_id Uniek administratie kenmerk.
Dit moet goed afgestemd worden met de onderwijsinstelling, om eventuele problemen te voorkomen bij meerdere leveranciers die gemandateerd zijn voor de onderwijsinstelling en dienst combinatie. 		Verplicht
service_version_namespace Namespace van de dienst Verplicht
url Technische locatie van de leverancier Verplicht
attributes Mogelijke attributen die ook opgeslagen moeten worden bij dit endpoint Optioneel
start_date* Start datum van het endpoint.
Indien dit niet meegegeven wordt, dan wordt de huidige datum hier automatisch ingevuld. start datum kan niet in het verleden liggen. 		Optioneel
end_date* Eind datum van het endpoint. Einddatum kan niet in het verleden liggen Optioneel

*start_date: middernacht aan het begin van de opgegeven datum
 *end_date: middernacht aan het einde van de opgegeven dag


 

Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=OSR:2019/toevoegen_wijzigen_endpoints&oldid=9643"