Schools

On this page, we'll dive into the different school endpoints you can use to manage schools programmatically. We'll look at how to query schools.

The school model

The school model contains all the information about schools, such as their name and id.

Properties

Name
id
Type
string
Description
Unique identifier for the school.
Name
name
Type
string
Description
The name for the school.
Name
logoUrl
Type
string
Description
The logo of the school
Name
duoCode
Type
string
Description
DUO code for the school
Name
type
Type
enum
Description
The type of school. Valid values: HBO, WO

GET/lml/v1/schools

Retrieve schools

This endpoint allows you to retrieve schools.

All schools are returned except ones that are hidden

Request

GET

/lml/v1/schools

curl -G https://lml-api.studiewinkel.nl/api/lml/v1/schools \
  -H "Authorization: Bearer {token}"

Response

[{
    "name": "NHL Stenden Hogeschool",
    "type": "HBO",
    "logoUrl": "",
}]

GET/lml/v1/schools/:id

Retrieve a school

This endpoint allows you to retrieve a school by providing the school id. Refer to the school at the top of this page to see which properties are included with school objects.

If the hidden prop of the school is true the school will not be returned in this endpoint

The location property is always the second item in the list breadcrumb (after the school name) and is often used for locations. This however cannot be guaranteed.

Optional attributes

Name
include
Type
csv
Description
Include related models (lists)

Request

GET

/lml/v1/schools/:slug

curl -G https://lml-api.studiewinkel.nl/api/lml/v1/schools/xJVox12l \
  -H "Authorization: Bearer {token}" \
  -d include=lists

Response

{
    "id": "clh09khb31jk494hu1nfui2x8",
    "name": "NHL Stenden Hogeschool",
    "type": "HBO",
    "logoUrl": "",
    "lists": [
        {
          "slug": "xJVox12l",
          "name": "Commerciële Economie Associate degree duaal/deeltijd",
          "location": "Emmen"
        },
        {
          ...
        }
    ],
}