Skip to content

The Learnspot API (1.0.0)

The Learnspot API documentation.

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.thelearnspot.nl/_mock/openapi/

https://docs.thelearnspot.nl/{serverUrl}/

OAuth

Operations

Modules

Operations

Subjects

Operations

Chapters

Operations

Store one chapter

Request

Create a chapter

Security
OAuth2
Bodyapplication/vnd.api+json
dataobject(Resource/Chapter/Store)required
data.​typestring(type)required
Default "chapters"
data.​attributesobjectrequired
data.​attributes.​titlestring(title)
Example: "Module 1 Oriëntatie op het beroep"
data.​attributes.​deeplinkstring(deeplink)
Example: "https://edition.thiememeulenhoff.nl/secure/d/stream/traject_3_4_mz_bop/link/thip_id/thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​attributes.​external_idstring(external_id)
Example: "thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​relationshipsobject
curl -i -X POST \
  https://docs.thelearnspot.nl/_mock/openapi/chapters \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
    "data": {
      "type": "chapters",
      "attributes": {
        "title": "Module 1 Oriëntatie op het beroep",
        "deeplink": "https://edition.thiememeulenhoff.nl/secure/d/stream/traject_3_4_mz_bop/link/thip_id/thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983",
        "external_id": "thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
      },
      "relationships": {
        "subject": {}
      }
    }
  }'

Responses

Store chapters

Bodyapplication/vnd.api+json
jsonapiobjectrequired
jsonapi.​versionstring(version)
Example: "1.0"
dataobject(Resource/Chapter/Fetch)required
data.​typestring(type)required
Default "chapters"
data.​idstringrequired
Example: "849b39ee-fe8e-46fb-bc9d-d98930ee6afb"
data.​attributesobjectrequired
data.​attributes.​titlestring(title)
Example: "Module 1 Oriëntatie op het beroep"
data.​attributes.​deeplinkstring(deeplink)
Example: "https://edition.thiememeulenhoff.nl/secure/d/stream/traject_3_4_mz_bop/link/thip_id/thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​attributes.​external_idstring(external_id)
Example: "thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​attributes.​createdAtstring(createdAt)read-only
Example: "2024-11-05T13:32:24.000000Z"
data.​attributes.​updatedAtstring(updatedAt)read-only
Example: "2024-11-05T13:32:24.000000Z"
data.​relationshipsobject
Response
application/vnd.api+json
{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "chapters",
    "id": "849b39ee-fe8e-46fb-bc9d-d98930ee6afb",
    "attributes": { … },
    "relationships": { … }
  }
}

Show one chapter

Request

Read a chapter

Security
OAuth2
Path
chapterstringrequired
Examples:
849b39ee-fe8e-46fb-bc9d-d98930ee6afb
3027c35b-df35-400b-8af2-d2e5dc050cb5
9e3718d1-b439-4e38-afa1-9863a9dd4c5d
curl -i -X GET \
  'https://docs.thelearnspot.nl/_mock/openapi/chapters/{chapter}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Show chapters

Bodyapplication/vnd.api+json
jsonapiobjectrequired
jsonapi.​versionstring(version)
Example: "1.0"
dataobject(Resource/Chapter/Fetch)required
data.​typestring(type)required
Default "chapters"
data.​idstringrequired
Example: "849b39ee-fe8e-46fb-bc9d-d98930ee6afb"
data.​attributesobjectrequired
data.​attributes.​titlestring(title)
Example: "Module 1 Oriëntatie op het beroep"
data.​attributes.​deeplinkstring(deeplink)
Example: "https://edition.thiememeulenhoff.nl/secure/d/stream/traject_3_4_mz_bop/link/thip_id/thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​attributes.​external_idstring(external_id)
Example: "thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​attributes.​createdAtstring(createdAt)read-only
Example: "2024-11-05T13:32:24.000000Z"
data.​attributes.​updatedAtstring(updatedAt)read-only
Example: "2024-11-05T13:32:24.000000Z"
data.​relationshipsobject
Response
application/vnd.api+json
{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "chapters",
    "id": "849b39ee-fe8e-46fb-bc9d-d98930ee6afb",
    "attributes": { … },
    "relationships": { … }
  }
}

Update one chapter

Request

Update a chapter

Security
OAuth2
Path
chapterstringrequired
Examples:
849b39ee-fe8e-46fb-bc9d-d98930ee6afb
3027c35b-df35-400b-8af2-d2e5dc050cb5
9e3718d1-b439-4e38-afa1-9863a9dd4c5d
Bodyapplication/vnd.api+json
dataobject(Resource/Chapter/Update)required
data.​typestring(type)required
Default "chapters"
data.​idstringrequired
Example: "849b39ee-fe8e-46fb-bc9d-d98930ee6afb"
data.​attributesobjectrequired
data.​attributes.​titlestring(title)
Example: "Module 1 Oriëntatie op het beroep"
data.​attributes.​deeplinkstring(deeplink)
Example: "https://edition.thiememeulenhoff.nl/secure/d/stream/traject_3_4_mz_bop/link/thip_id/thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​attributes.​external_idstring(external_id)
Example: "thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​relationshipsobject
curl -i -X PATCH \
  'https://docs.thelearnspot.nl/_mock/openapi/chapters/{chapter}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
    "data": {
      "type": "chapters",
      "id": "849b39ee-fe8e-46fb-bc9d-d98930ee6afb",
      "attributes": {
        "title": "Module 1 Oriëntatie op het beroep",
        "deeplink": "https://edition.thiememeulenhoff.nl/secure/d/stream/traject_3_4_mz_bop/link/thip_id/thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983",
        "external_id": "thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
      },
      "relationships": {
        "subject": {}
      }
    }
  }'

Responses

Update chapters

Bodyapplication/vnd.api+json
jsonapiobjectrequired
jsonapi.​versionstring(version)
Example: "1.0"
dataobject(Resource/Chapter/Fetch)required
data.​typestring(type)required
Default "chapters"
data.​idstringrequired
Example: "849b39ee-fe8e-46fb-bc9d-d98930ee6afb"
data.​attributesobjectrequired
data.​attributes.​titlestring(title)
Example: "Module 1 Oriëntatie op het beroep"
data.​attributes.​deeplinkstring(deeplink)
Example: "https://edition.thiememeulenhoff.nl/secure/d/stream/traject_3_4_mz_bop/link/thip_id/thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​attributes.​external_idstring(external_id)
Example: "thip.f6f15d45-aec1-4450-b5ec-cff9c74a2983"
data.​attributes.​createdAtstring(createdAt)read-only
Example: "2024-11-05T13:32:24.000000Z"
data.​attributes.​updatedAtstring(updatedAt)read-only
Example: "2024-11-05T13:32:24.000000Z"
data.​relationshipsobject
Response
application/vnd.api+json
{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "chapters",
    "id": "849b39ee-fe8e-46fb-bc9d-d98930ee6afb",
    "attributes": { … },
    "relationships": { … }
  }
}

Show subject

Request

Security
OAuth2
Path
chapterstringrequired
Examples:
849b39ee-fe8e-46fb-bc9d-d98930ee6afb
3027c35b-df35-400b-8af2-d2e5dc050cb5
9e3718d1-b439-4e38-afa1-9863a9dd4c5d
curl -i -X GET \
  'https://docs.thelearnspot.nl/_mock/openapi/chapters/{chapter}/subject' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

ShowRelated chapters

Bodyapplication/vnd.api+json
jsonapiobjectrequired
jsonapi.​versionstring(version)
Example: "1.0"
dataobject(Resource/Subject/Fetch)required
data.​typestring(type)required
Default "subjects"
data.​idstringrequired
Example: "2f94483e-dd7b-4fb7-8f97-f7c91433eeba"
data.​attributesobjectrequired
data.​attributes.​titlestring(title)
Example: "Dit is een test"
data.​attributes.​introductionstring(introduction)
Example: "Test content"
data.​attributes.​contentstring(content)
Example: ""
data.​attributes.​external_idstring(external_id)
Example: "thip.a897b758-04aa-49ff-9017-347ab78267b9"
data.​attributes.​available_for_coursesboolean(available_for_courses)
Example: false
data.​attributes.​created_atstring(created_at)read-only
Example: "2024-11-05T13:32:24.000000Z"
data.​attributes.​updated_atstring(updated_at)read-only
Example: "2024-11-08T13:55:00.000000Z"
data.​relationshipsobject
Response
application/vnd.api+json
{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "subjects",
    "id": "2f94483e-dd7b-4fb7-8f97-f7c91433eeba",
    "attributes": { … },
    "relationships": { … }
  }
}

Show subject relation

Request

Security
OAuth2
Path
chapterstringrequired
Examples:
849b39ee-fe8e-46fb-bc9d-d98930ee6afb
3027c35b-df35-400b-8af2-d2e5dc050cb5
9e3718d1-b439-4e38-afa1-9863a9dd4c5d
curl -i -X GET \
  'https://docs.thelearnspot.nl/_mock/openapi/chapters/{chapter}/relationships/subject' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Show chapters

Bodyapplication/vnd.api+json
jsonapiobjectrequired
jsonapi.​versionstring(version)
Example: "1.0"
dataobject(Resource/Chapter/Relationship/Subject/Fetch)required
data.​typestring(type)required
Default "subjects"
data.​idstring(id)required
Example: "2f94483e-dd7b-4fb7-8f97-f7c91433eeba"
Response
application/vnd.api+json
{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "subjects",
    "id": "2f94483e-dd7b-4fb7-8f97-f7c91433eeba"
  }
}