Guardian API
An API for information about students’ parents/guardians, and vice versa.
Warning
This is a proof of concept implementation. It may be changed or discontinued at short notice.
All calls are to be made using ‘POST’.
Examples
This section contains two examples. One example looks up the guardians for a given student, while the other example looks up the students of a given guardian.
Both examples assume that you are logged into Feide and that $TOKEN
contains the access token you
received during authentication. You must also have the gk_guardianapi
scope in order to be able to
access this API.
Guardians for a student
Look up the guardians of a given student.
curl -sS -H "Authorization: Bearer $TOKEN" -d student=thea_elevg@spusers.feide.no \
https://guardianapi.dataporten-api.no/student_guardians
[{"name":"Sivilisert Fyrstinne","norEduPersonGuardianNIN":"05917797813"},
{"name":"Hensynsfull Måne","norEduPersonGuardianNIN":"49857200151"}]
Returns application/json
array of one object for each of the student’s guardians. Currently,
the only attributes are name
and norEduPersonGuardianNIN
- The first contains the full name of the guardian, if available, from the National Population Register. The latter is the national ID number of the guardian
In this proof of concept implementation, only the logged in student’s own guardians may be looked
up. It is possible that we may later want to allow teachers or administrators to perform the call.
This is the reason that there is an explicit student
parameter.
Students for a guardian
Look up students for a given guardian.
curl -sS -H "Authorization: Bearer $TOKEN" -d guardian=21079416549 -d realm=spusers.feide.no \
https://guardianapi.dataporten-api.no/guardian_students
[{"eduPersonPrincipalName": "thea_elevg@spusers.feide.no",
"email": "thea.nilsen@test.feide.no",
"userid": "9eb60ee0-8d10-410d-93a8-04190d51ba89",
"givenName": "Thea",
"norEduPersonLegalName": "Thea Nilsen"}]
Returns application/json
array of one object for each of the
students in a Feide realm the guardian is parent/guardian of. The possible attributes of the students that can be returned are
eduPersonPrincipalName
, email
, mobile
, norEduPersonNIN
, userid
, givenName
, norEduPersonLegalName
if they are available in the system. If there are more than one student for a guardian, there will be an object like this for each different student.
In this proof of concept implementation, only the logged in guardian’s own students may be looked
up. It is possible that we may later want to allow teachers or administrators to perform the call.
This is the reason that there is an explicit guardian
parameter.