Studiz Technical Documentation

A services defines some resource and what exactly you can do with it. Click on the service methods to expand details.

How to use API?

Parse authorization token in header:
• Header name: Authorization
• Header value: Token token=[token]

Header should look like this: Authorization: Token token="abc", where "abc is token

Base url: https://www.studiz.dk/

Params may be passed in URL or via header (if passed in header Content-type must be set to application/json)

Verification

Check or set verifcation status for specific student

/api/v3/student_verified
Key
Parameter
Description
Data type
Required?
id
Studiz user-id
Uniq ID for user in Studiz database
string
true
Eksample:
{"id" : "12345"}
Response:
{verified: true}
/api/v3/student_verified
Key
Parameter
Description
Data type
Required?
student
E-mail
E-mail adress that student signed up with at Studiz
string
true
student
Password
Password for Studiz account
string
true
Eksample:
{
"student" : {
"email" : "[email protected]",
"password" : "test1234"}
}
Response:
{verified: true}

Unverify

Remove verification of specific student

/api/v3/institution_students/unverify
Key
Parameter
Description
Data type
Required?
institution_student
Id
Uniq identifier for student (can be WAYF-uid, UNI-login or student number)
string
true
Eksample:
{
"institution_student" : {
"id" : "WAYF-DK-4238649ddada06298f1f4016c1ff7f9c49fdde2164ab"}
}
Response:
{verified: false}

Institution list

Get Studiz id's for all institutions

/api/v3/institutions
Key
Parameter
Description
Data type
Required?
No Params should be passed
Response:
{"id":1,"name":"University College Zealand - UCSJ"},
{"id":2,"name":"IT University of Copenhagen - ITU"},
{"id":3,"name":"University of Copenhagen"},
{"id":4,"name":"Copenhagen Business School - Handelshøjskolen"},
{"id":5,"name":"Technical University of Denmark - DTU"},
{"id":6,"name":"RUC Roskilde University"},
{"id":7,"name":"University of Southern Denmark"},
{"id":8,"name":"Aarhus University"},
{"id":9,"name":"Aalborg University"}
etc…

Institution students

Get, create, update or delete institution students

/api/v3/institution_students
Key
Parameter
Description
Data type
Required?
No key - param passed in URL
institution_id
ID of institution that student belongs to (institution ids can be found through institution list call)
integer
false
No key - param passed in URL
student_id
Uniq identifier for student (can be WAYF-uid, UNI-login or student number)
string
false
Eksample:
https://www.studiz.dk/api/v3/institution_students?institution_id=2

OR

https://www.studiz.dk/api/v3/institution_students?student_id=WAYF-DK-42318649d06298f1f4016c1ff7f9c49fdde2164a222b
Response:
{
"{"name": "Studiz Academy","students": [{"identifier": "70376","inst_data_full_name": "Lars Sørensen","inst_data_phone": "12345678","inst_data_gender": 1,"inst_data_birthday": 1986-08-30,"inst_data_student_number": "xp202212","avatar_uploaded_at": "2016-04-15","study_start_year": 2024,"preferred_language": "da","verified_until": "2025-08-30T00:00:00.000+02:00","school_class_id": 5334,"school_class": {"id": 5334,"name": "1.X"},"institutions_subject_teams": [{"id": 23021,"name": "Dansk01"},{"id": 23022,"name": "Matematik20"}]},
OR
{"identifier": "70376","inst_data_full_name": "Lars Sørensen","inst_data_phone": "12345678","inst_data_gender": 1,"inst_data_birthday": 1986-08-30,"inst_data_student_number": "xp202212","avatar_uploaded_at": "2016-04-15","study_start_year": 2024,"preferred_language": "da", "verified_until": "2025-08-30T00:00:00.000+02:00","school_class_id": 5334,"school_class": {"id": 5334,"name": "1.X"},"institutions_subject_teams": [{"id": 23021,"name": "Dansk01"},{"id": 23022,"name": "Matematik20"}]}
/api/v3/institution_students
Key
Parameter
Description
Data type
Required?
institution
institution_id
ID of institution that student belongs to (institution ids can be found through institution list call)
Integer
true
institution_student
full_name
Student's full name
string
true
institution_student
id
Uniq identifier for student (can be WAYF-uid, UNI-login, or student number)
string
true
institution_student
birthday
Student's birthday (format must be: dd-mm-yyyy)
date
true
institution_student
student_number
Student's student number
string
false
institution_student
school_email
Student's school e-mail
string
false
institution_student
phone
Student's phone number
string
false
institution_student
photo_url
Url for student's student-id photo
string
false
institution_student
verified_until
Date that student's student-id should expire
datetime
false
institution_student
preferred_language
Student's preferred language (eg. 'da' for Danish or 'en' for English)
string
false
institution_student
study_start_year
Year that student started studies
integer
false
school_class
name
Name of school class (eg. 1.x)
string
false
school_class
teacher_name
Name of responsible teacher
string
false
subject_teams
name
Name of subject (eg. Dansk2015)
string
false
subject_teams
teacher_name
Name of responsible teacher
string
false
Eksample:
{
"institution":
{"institution_id" : "347"},
"institution_student":
{ "id": "12223", "full_name" : "Jens Jensen", "student_number" : "21EE21",”birthday”:”30-08-1986” }
"school_class":
{"name" : "1.X","teacher_name" : "Jens Hansen"}
"subject_teams":
[{"name" : "Dansk01", "teacher_name" : "Sofia Petersen"}, {"name" : "Matematik20", "teacher_name" : "Søren Larsen"}]
}
Response:
{message: “institution student saved”}

*If institution uses verification mail as verification method system will return activation_token and if school_email is given activation_link as well.
/api/v3/institution_students/{:id}
Key
Parameter
Description
Data type
Required?
institution
institution_id
ID of institution that student belongs to (institution ids can be found through institution list call)
Integer
true
institution_student
full_name
Student's full name
string
true
institution_student
id
Uniq identifier for student (can be WAYF-uid, UNI-login, or student number)
string
true
institution_student
birthday
Student's birthday (format must be: dd-mm-yyyy)
date
true
institution_student
student_number
Student's student number
string
false
institution_student
school_email
Student's school e-mail
string
false
institution_student
phone
Student's phone number
string
false
institution_student
photo_url
Url for student's student-id photo
string
false
institution_student
verified_until
Date that student's student-id should expire
datetime
false
institution_student
preferred_language
Student's preferred language (eg. 'da' for Danish or 'en' for English)
string
false
institution_student
study_start_year
Year that student started studies
integer
false
school_class
name
Name of school class (eg. 1.x)
string
false
school_class
teacher_name
Name of responsible teacher
string
false
subject_teams
name
Name of subject (eg. Dansk2015)
string
false
subject_teams
teacher_name
Name of responsible teacher
string
false
Eksample:
{
"institution":
{"institution_id" : "347"},
"institution_student":
{ "id": "12223", "full_name" : "Jens Jensen", "student_number" : "21EE21",”birthday”:”30-08-1986” }
"school_class":
{"name" : "1.X","teacher_name" : "Jens Hansen"}
"subject_teams":
[{"name" : "Dansk01", "teacher_name" : "Sofia Petersen"}, {"name" : "Matematik20", "teacher_name" : "Søren Larsen"}]
}
Response:
{message: “student updated”}

*If institution uses verification mail as verification method system will return activation_token and if school_email is given activation_link as well.
/api/v3/institution_students
Key
Parameter
Description
Data type
Required?
institution_student
Id
Uniq identifier for student (can be WAYF-uid, UNI-login or student number)
string
true
Eksample:
{
"institution_student":
{ id": "12223",” }
}
Response:
{message: institution student deleted”}

Study-id photo's

Get all student-ID photos from specific institution or delete, upload or delete specific students photo.

/api/v3/study_id_photos
Key
Parameter
Description
Data type
Required?
No key - param passed in URL
institution_id
ID of institution that student belongs to (institution ids can be found through institution list call)
integer
false
No key - param passed in URL
student_id
Uniq identifier for student (can be WAYF-uid, UNI-login or student number)
string
false
Eksample:
https://www.studiz.dk/api/v3/study_id_photos?institution_id=2

OR

https://www.studiz.dk/api/v3/study_id_photos?student_id=WAYF-DK-42318649d06298f1f4016c1ff7f9c49fdde2164a222b
Response:
{
"student_id": "WAYF-DK-42318649d06298f1f4016c1ff7f9c49fdde2164a222b"
"photo_uploaded": "2018-02-16"
"student_original_photo_url": "https://www.studiz.dk/avatar?id=48843&role=Student&version=original"
"student_standard_photo_url": "https://www.studiz.dk/avatar?id=48843&role=Student&version=standard"
"student_portrait_photo_url": "https://www.studiz.dk/avatar?id=48843&role=Student&version=portrait"
"student_elevplan_photo_url": "https://www.studiz.dk/avatar?id=48843&role=Student&version=elevplan"
}
OR
{
"photo_uploaded": "2018-02-16"
"student_original_photo_url": "https://www.studiz.dk/avatar?id=1018843&role=Student&version=original"
"student_standard_photo_url": https://www.studiz.dk/avatar?id=1018843&role=Student&version=standard"
"student_portrait_photo_url": https://www.studiz.dk/avatar?id=1018843&role=Student&version=portrait"
"student_elevplan_photo_url": https://www.studiz.dk/avatar?id=1018843&role=Student&version=elevplan"
}
NB: For security reasons token must be passed in header when calling student_photo_url in order to get photo.
The original version, is the version uploaded by the student.
The standard version is the one used in the app - it is a cropped and scaled version that fits 250x250 px.
The portrait version is a cropped and scaled version with an aspect ratio of 4:3 that fits 343x453 px. (transparency is added for the extra height)
The 'elevplan' version is a version optimized to fit elevplan (Administrationsystem)

Not all versions exists for all students.
/api/v3/study_id_photos
Key
Parameter
Description
Data type
Required?
study_id_photo
id
Uniq identifier for student (can be WAYF-uid, UNI-login or student number)
string
true
study_id_photo
photo_url
Url where student photo can be found
string
false
study_id_photo
file
Image file or Base64 representation
file / string
false
Eksample:
{
"study_id_photo" : {
"id" : "mari2912",
"photo_url" : "http://www.example.dk/student_photos/maria_jensen"
"file" : "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ"
}
}
Response:
{message: "Photo uploaded"}
/api/v3/study_id_photos
Key
Parameter
Description
Data type
Required?
study_id_photo
id
Uniq identifier for student (can be WAYF-uid, UNI-login or student number)
string
true
Eksample:
{
"study_id_photo":
{ id": "WAYF-DK-4238649ddada06298f1f4016c1ff7f9c49fdde2164ab"}
}
Response:
{message: “Student photo deleted”}
OBS: Student are informed via e-mail that photo has been deleted if he/she has activated user
Studiz ApS ©
Customer Care: (+45) 71 99 75 20
E-mail: [email protected]
Terms and conditions
Start live chat
Start live chat