KNF:ARP service: verschil tussen versies

Uit Kennisnet Developers Documentatie
Naar navigatie springen Naar zoeken springen
(Nieuwe pagina aangemaakt met 'Door middel van een Attribute Release Policy (ARP) bepaalt een onderwijsinstelling welke attributen (of persoonsgegevens) van haar gebruikers worden doorgegeven aan...')
 
 
(11 tussenliggende versies door 2 gebruikers niet weergegeven)
Regel 1: Regel 1:
  +
=Inleiding=
 
Door middel van een Attribute Release Policy (ARP) bepaalt een onderwijsinstelling welke attributen (of persoonsgegevens) van haar gebruikers worden doorgegeven aan een Service Provider. Wanneer de configuratie van de ARP onjuist is kan dit ertoe leiden tot verstoring in de toegang tot digitale leermiddelen. De ARP service kan gebruikt worden om de actuele ARP configuratie op te vragen.
  
Door middel van een Attribute Release Policy (ARP) bepaalt een onderwijsinstelling welke attributen (of persoonsgegevens) van haar gebruikers worden doorgegeven aan een Service Provider. Wanneer de configuratie van de ARP onjuist is kan dit ertoe leiden tot verstoring in de toegang tot digitale leermiddelen. De ARP service kan gebruikt worden om de actuele ARP configuratie op te vragen.
  +
  +
{{Info|Voor het gebruik van de ARP service is een API key nodig. Deze kan worden aangevraagd bij [mailto:implementaties@kennisnet.nl Kennisnet]}}
  +
  +
De URL voor de ARP service is: https://arpservice.entree.kennisnet.nl
  +
  +
De ARP service kent vier operaties:
  +
# Een lijst met alle scholen opvragen: ''/v2/arp/school-list''
  +
# Een lijst met alle Service Providers opvragen: ''/v2/arp/sp-list''
  +
# ARP configuratie voor een school – SP combinatie opvragen: ''/v2/arp/school/{brin}/sp/{organisationCode}''
  +
  +
==Technisch documentatie ==
  +
De Swagger documentatie voor de v2 API is te vinden op: https://arpservice.entree.kennisnet.nl/swagger-ui/index.html?urls.primaryName=ARP%20V2%20(new%20platform)
  +
  +
De v2 API is reeds beschikbaar sinds juli 2022 en deze release bevat geen wijzigingen voor de v2 API.
  +
  +
==Foutmeldingen==
  +
De ARP service kan de volgende antwoorden geven op foutieve aanvragen:
  +
  +
===Ongeldige API key===
  +
Foutmelding wanneer de gebruikte API key niet geldig is (geldt voor alle operaties)
  +
  +
'''Antwoord:'''
  +
<syntaxhighlight lang="json">
  +
{
  +
    "timestamp": "2021-02-22T16:56:13.696+0000",
  +
    "status": 403,
  +
    "error": "Forbidden",
  +
    "message": "403 Forbidden",
  +
    "path": "/v2/arp/school-list"
  +
}
  +
</syntaxhighlight>
  +
  +
===Geen ARP configuratie bekend voor onderwijsinstelling en Service Provider===
  +
Foutmelding wanneer er geen ARP configuratie bekend is voor de combinatie van het BRIN nummer en de organisatieCode.
  +
  +
'''Antwoord:'''
  +
<syntaxhighlight lang="json">
  +
{
  +
    "timestamp": "2021-02-22T15:48:12.902+0000",
  +
    "status": 400,
  +
    "error": "Bad Request",
  +
    "message": "ARP configuration unavailable for school-Service Provider combination",
  +
    "path": "/v2/arp/school/20MG/sp/abcxyz"
  +
}
  +
</syntaxhighlight>
  +
  +
===Interne server foutmelding ARP service===
  +
Foutmelding wanneer de ARP service een interne fout genereert (geldt voor alle operaties)
  +
  +
'''Antwoord:'''
  +
<syntaxhighlight lang="json">
  +
{
  +
    "timestamp": "2021-02-22T17:04:55.481+0000",
  +
    "status": 500,
  +
    "error": "Internal Server Error",
  +
    "message": "500 INTERNAL SERVER ERROR",
  +
    "path": "/v2/arp/school-list"
  +
}
  +
</syntaxhighlight>

Huidige versie van 12 jan 2024 om 15:46

Inleiding

Door middel van een Attribute Release Policy (ARP) bepaalt een onderwijsinstelling welke attributen (of persoonsgegevens) van haar gebruikers worden doorgegeven aan een Service Provider. Wanneer de configuratie van de ARP onjuist is kan dit ertoe leiden tot verstoring in de toegang tot digitale leermiddelen. De ARP service kan gebruikt worden om de actuele ARP configuratie op te vragen.

Info.gif Voor het gebruik van de ARP service is een API key nodig. Deze kan worden aangevraagd bij Kennisnet

De URL voor de ARP service is: https://arpservice.entree.kennisnet.nl

De ARP service kent vier operaties:

  1. Een lijst met alle scholen opvragen: /v2/arp/school-list
  2. Een lijst met alle Service Providers opvragen: /v2/arp/sp-list
  3. ARP configuratie voor een school – SP combinatie opvragen: /v2/arp/school/{brin}/sp/{organisationCode}

Technisch documentatie

De Swagger documentatie voor de v2 API is te vinden op: https://arpservice.entree.kennisnet.nl/swagger-ui/index.html?urls.primaryName=ARP%20V2%20(new%20platform)

De v2 API is reeds beschikbaar sinds juli 2022 en deze release bevat geen wijzigingen voor de v2 API.

Foutmeldingen

De ARP service kan de volgende antwoorden geven op foutieve aanvragen:

Ongeldige API key

Foutmelding wanneer de gebruikte API key niet geldig is (geldt voor alle operaties)

Antwoord: 

{
    "timestamp": "2021-02-22T16:56:13.696+0000",
    "status": 403,
    "error": "Forbidden",
    "message": "403 Forbidden",
    "path": "/v2/arp/school-list"
}

Geen ARP configuratie bekend voor onderwijsinstelling en Service Provider

Foutmelding wanneer er geen ARP configuratie bekend is voor de combinatie van het BRIN nummer en de organisatieCode.

Antwoord: 

{
    "timestamp": "2021-02-22T15:48:12.902+0000",
    "status": 400,
    "error": "Bad Request",
    "message": "ARP configuration unavailable for school-Service Provider combination",
    "path": "/v2/arp/school/20MG/sp/abcxyz"
}

Interne server foutmelding ARP service

Foutmelding wanneer de ARP service een interne fout genereert (geldt voor alle operaties)

Antwoord: 

{
    "timestamp": "2021-02-22T17:04:55.481+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "500 INTERNAL SERVER ERROR",
    "path": "/v2/arp/school-list"
}
Overgenomen van "https://developers.wiki.kennisnet.nl/index.php?title=KNF:ARP_service&oldid=12939"