Store one subject

OAuth

Operations

Modules

Operations

Subjects

Operations

Get all subjects

Request

Security

OAuth2

Query

page[size]integer

The page size for paginated results

page[number]integer

The page number for paginated results

sortArray of strings

Items Enum"id""-id""created_at""-created_at""updated_at""-updated_at"

filter[id]Array of strings

A list of ids to filter by.

Default []

Examples:

empty filter[id]=

2f94483e-dd7b-4fb7-8f97-f7c91433eeba filter[id]=2f94483e-dd7b-4fb7-8f97-f7c91433eeba

c9b44316-411a-4bcc-a767-27a9e487084b filter[id]=c9b44316-411a-4bcc-a767-27a9e487084b

e28b07db-19c0-4143-a0f3-347853657c3b filter[id]=e28b07db-19c0-4143-a0f3-347853657c3b

filter[title]string

Filters the records

Default ""

Examples:

Dit is een test filter[title]=Dit is een test

Communicatie en ondersteunen filter[title]=Communicatie en ondersteunen

Methodiek en gedragsbevordering filter[title]=Methodiek en gedragsbevordering

filter[external_id]string

Filters the records

Default ""

Examples:

thip.a897b758-04aa-49ff-9017-347ab78267b9 filter[external_id]=thip.a897b758-04aa-49ff-9017-347ab78267b9

thip.17c3e4df-1d43-4ff5-9aac-f1cc42c0a18e filter[external_id]=thip.17c3e4df-1d43-4ff5-9aac-f1cc42c0a18e

thip.5f9bc11e-33e5-4d81-9b19-7de60c82e969 filter[external_id]=thip.5f9bc11e-33e5-4d81-9b19-7de60c82e969

curl -i -X GET \
  'https://docs.thelearnspot.nl/_mock/openapi/subjects?page%5Bsize%5D=0&page%5Bnumber%5D=0&sort=id' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Index subjects

Bodyapplication/vnd.api+json

jsonapiobjectrequired

jsonapi.versionstring(version)

Example: "1.0"

dataArray of objects(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": [
    { … }
  ]
}

Store one subject

Request

Security

OAuth2

Bodyapplication/vnd.api+json

dataobject(Resource/Subject/Store)required

data.typestring(type)required

Default "subjects"

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.relationshipsobject

curl -i -X POST \
  https://docs.thelearnspot.nl/_mock/openapi/subjects \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
    "data": {
      "type": "subjects",
      "attributes": {
        "title": "Dit is een test",
        "introduction": "Test content",
        "content": "",
        "external_id": "thip.a897b758-04aa-49ff-9017-347ab78267b9",
        "available_for_courses": false
      },
      "relationships": {
        "module": {},
        "chapters": {}
      }
    }
  }'

Responses

Store subjects

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 one subject

Request

Security

OAuth2

Path

subjectstringrequired

Examples:

2f94483e-dd7b-4fb7-8f97-f7c91433eeba 2f94483e-dd7b-4fb7-8f97-f7c91433eeba

c9b44316-411a-4bcc-a767-27a9e487084b c9b44316-411a-4bcc-a767-27a9e487084b

e28b07db-19c0-4143-a0f3-347853657c3b e28b07db-19c0-4143-a0f3-347853657c3b

curl -i -X GET \
  'https://docs.thelearnspot.nl/_mock/openapi/subjects/{subject}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Show subjects

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": { … }
  }
}

Update one subject

Request

Security

OAuth2

Path

subjectstringrequired

Examples:

2f94483e-dd7b-4fb7-8f97-f7c91433eeba 2f94483e-dd7b-4fb7-8f97-f7c91433eeba

c9b44316-411a-4bcc-a767-27a9e487084b c9b44316-411a-4bcc-a767-27a9e487084b

e28b07db-19c0-4143-a0f3-347853657c3b e28b07db-19c0-4143-a0f3-347853657c3b

Bodyapplication/vnd.api+json

dataobject(Resource/Subject/Update)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.relationshipsobject

curl -i -X PATCH \
  'https://docs.thelearnspot.nl/_mock/openapi/subjects/{subject}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
    "data": {
      "type": "subjects",
      "id": "2f94483e-dd7b-4fb7-8f97-f7c91433eeba",
      "attributes": {
        "title": "Dit is een test",
        "introduction": "Test content",
        "content": "",
        "external_id": "thip.a897b758-04aa-49ff-9017-347ab78267b9",
        "available_for_courses": false
      },
      "relationships": {
        "module": {},
        "chapters": {}
      }
    }
  }'

Responses

Update subjects

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 module

Request

Security

OAuth2

Path

subjectstringrequired

Examples:

2f94483e-dd7b-4fb7-8f97-f7c91433eeba 2f94483e-dd7b-4fb7-8f97-f7c91433eeba

c9b44316-411a-4bcc-a767-27a9e487084b c9b44316-411a-4bcc-a767-27a9e487084b

e28b07db-19c0-4143-a0f3-347853657c3b e28b07db-19c0-4143-a0f3-347853657c3b

curl -i -X GET \
  'https://docs.thelearnspot.nl/_mock/openapi/subjects/{subject}/module' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

ShowRelated subjects

Bodyapplication/vnd.api+json

jsonapiobjectrequired

jsonapi.versionstring(version)

Example: "1.0"

dataobject(Resource/Module/Fetch)required

data.typestring(type)required

Default "modules"

data.idstringrequired

Example: "63fa853f-2769-4682-a0ec-600858474b26"

data.attributesobjectrequired

data.attributes.titlestring(title)

Example: "Dit is een test"

data.attributes.introductionstring(introduction)

Example: "Test introduction"

data.attributes.contentstring(content)

Example: "<p>Test content</p>"

data.attributes.external_idstring(external_id)

Example: "edition-traject-mz-kd2022"

data.attributes.publishedboolean(published)read-only

Example: false

data.attributes.created_atstring(created_at)read-only

Example: "2024-11-05T13:32:23.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": "modules",
    "id": "63fa853f-2769-4682-a0ec-600858474b26",
    "attributes": { … },
    "relationships": { … }
  }
}

Show module relation

Request

Security

OAuth2

Path

subjectstringrequired

Examples:

2f94483e-dd7b-4fb7-8f97-f7c91433eeba 2f94483e-dd7b-4fb7-8f97-f7c91433eeba

c9b44316-411a-4bcc-a767-27a9e487084b c9b44316-411a-4bcc-a767-27a9e487084b

e28b07db-19c0-4143-a0f3-347853657c3b e28b07db-19c0-4143-a0f3-347853657c3b

curl -i -X GET \
  'https://docs.thelearnspot.nl/_mock/openapi/subjects/{subject}/relationships/module' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Show subjects

Bodyapplication/vnd.api+json

jsonapiobjectrequired

jsonapi.versionstring(version)

Example: "1.0"

dataobject(Resource/Subject/Relationship/Module/Fetch)required

data.typestring(type)required

Default "modules"

data.idstring(id)required

Example: "63fa853f-2769-4682-a0ec-600858474b26"

Response

application/vnd.api+json

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": {
    "type": "modules",
    "id": "63fa853f-2769-4682-a0ec-600858474b26"
  }
}

Show chapters

Request

Security

OAuth2

Path

subjectstringrequired

Examples:

2f94483e-dd7b-4fb7-8f97-f7c91433eeba 2f94483e-dd7b-4fb7-8f97-f7c91433eeba

c9b44316-411a-4bcc-a767-27a9e487084b c9b44316-411a-4bcc-a767-27a9e487084b

e28b07db-19c0-4143-a0f3-347853657c3b e28b07db-19c0-4143-a0f3-347853657c3b

curl -i -X GET \
  'https://docs.thelearnspot.nl/_mock/openapi/subjects/{subject}/chapters' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

ShowRelated subjects

Bodyapplication/vnd.api+json

jsonapiobjectrequired

jsonapi.versionstring(version)

Example: "1.0"

dataArray of objects(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": [
    { … }
  ]
}

Show chapters relation

Request

Security

OAuth2

Path

subjectstringrequired

Examples:

2f94483e-dd7b-4fb7-8f97-f7c91433eeba 2f94483e-dd7b-4fb7-8f97-f7c91433eeba

c9b44316-411a-4bcc-a767-27a9e487084b c9b44316-411a-4bcc-a767-27a9e487084b

e28b07db-19c0-4143-a0f3-347853657c3b e28b07db-19c0-4143-a0f3-347853657c3b

curl -i -X GET \
  'https://docs.thelearnspot.nl/_mock/openapi/subjects/{subject}/relationships/chapters' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Show subjects

Bodyapplication/vnd.api+json

jsonapiobjectrequired

jsonapi.versionstring(version)

Example: "1.0"

dataArray of objects(Resource/Subject/Relationship/Chapters/Fetch)required

data[].typestring(type)required

Default "chapters"

data[].idstring(id)required

Example: "849b39ee-fe8e-46fb-bc9d-d98930ee6afb"

Response

application/vnd.api+json

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    { … }
  ]
}

Chapters

Operations

The Learnspot API (1.0.0)

OAuth

Modules

Subjects

Get all subjects

Request

Responses

Was this helpful?

Store one subject

Request

Responses

Was this helpful?

Show one subject

Request

Responses

Was this helpful?

Update one subject

Request

Responses

Was this helpful?

Show module

Request

Responses

Was this helpful?

Show module relation

Request

Responses

Was this helpful?

Show chapters

Request

Responses

Was this helpful?

Show chapters relation

Request

Responses

Was this helpful?

Chapters

The Learnspot API (1.0.0)

OAuth

Modules

Subjects

Get all subjects

Request

Responses

Was this helpful?

Store one subject

RequestExpand all

Responses

Was this helpful?

Show one subject

Request

Responses

Was this helpful?

Update one subject

RequestExpand all

Responses

Was this helpful?

Show module

Request

Responses

Was this helpful?

Show module relation

Request

Responses

Was this helpful?

Show chapters

Request

Responses

Was this helpful?

Show chapters relation

Request

Responses

Was this helpful?

Chapters

Request

Request