Store one module

OAuth

Operations

Modules

Operations

Get all modules

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""title""-title""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]=

63fa853f-2769-4682-a0ec-600858474b26 filter[id]=63fa853f-2769-4682-a0ec-600858474b26

a6760ecb-20fe-4f34-bbde-bb5b4b68a18b filter[id]=a6760ecb-20fe-4f34-bbde-bb5b4b68a18b

6c163f9d-ea45-481b-964e-1c1c13401744 filter[id]=6c163f9d-ea45-481b-964e-1c1c13401744

filter[title]string

Filters the records

Default ""

Examples:

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

Ondersteunen (en coördineren) op maat MZ KD2022 filter[title]=Ondersteunen (en coördineren) op maat MZ KD2022

Maatschappelijke zorg KD2016 filter[title]=Maatschappelijke zorg KD2016

filter[external_id]string

Filters the records

Default ""

Examples:

edition-traject-mz-kd2022 filter[external_id]=edition-traject-mz-kd2022

edition-traject-ondersteunen-coordineren-mz-kd2022 filter[external_id]=edition-traject-ondersteunen-coordineren-mz-kd2022

edition-traject-mz-kd2016 filter[external_id]=edition-traject-mz-kd2016

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

Responses

Index modules

Bodyapplication/vnd.api+json

jsonapiobjectrequired

jsonapi.versionstring(version)

Example: "1.0"

dataArray of objects(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: "Test content"

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

Store one module

Request

Security

OAuth2

Bodyapplication/vnd.api+json

dataobject(Resource/Module/Store)required

data.typestring(type)required

Default "modules"

data.attributesobjectrequired

data.attributes.titlestring(title)

Example: "Dit is een test"

data.attributes.introductionstring(introduction)

Example: "Test introduction"

data.attributes.contentstring(content)

Example: "Test content"

data.attributes.external_idstring(external_id)

Example: "edition-traject-mz-kd2022"

data.relationshipsobject

curl -i -X POST \
  https://docs.thelearnspot.nl/_mock/openapi/modules \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
    "data": {
      "type": "modules",
      "attributes": {
        "title": "Dit is een test",
        "introduction": "Test introduction",
        "content": "<p>Test content</p>",
        "external_id": "edition-traject-mz-kd2022"
      },
      "relationships": {
        "subjects": {}
      }
    }
  }'

Responses

Store modules

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: "Test content"

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

Request

Security

OAuth2

Path

modulestringrequired

Examples:

63fa853f-2769-4682-a0ec-600858474b26 63fa853f-2769-4682-a0ec-600858474b26

a6760ecb-20fe-4f34-bbde-bb5b4b68a18b a6760ecb-20fe-4f34-bbde-bb5b4b68a18b

6c163f9d-ea45-481b-964e-1c1c13401744 6c163f9d-ea45-481b-964e-1c1c13401744

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

Responses

Show modules

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: "Test content"

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

Update one module

Request

Security

OAuth2

Path

modulestringrequired

Examples:

63fa853f-2769-4682-a0ec-600858474b26 63fa853f-2769-4682-a0ec-600858474b26

a6760ecb-20fe-4f34-bbde-bb5b4b68a18b a6760ecb-20fe-4f34-bbde-bb5b4b68a18b

6c163f9d-ea45-481b-964e-1c1c13401744 6c163f9d-ea45-481b-964e-1c1c13401744

Bodyapplication/vnd.api+json

dataobject(Resource/Module/Update)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: "Test content"

data.attributes.external_idstring(external_id)

Example: "edition-traject-mz-kd2022"

data.relationshipsobject

curl -i -X PATCH \
  'https://docs.thelearnspot.nl/_mock/openapi/modules/{module}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
    "data": {
      "type": "modules",
      "id": "63fa853f-2769-4682-a0ec-600858474b26",
      "attributes": {
        "title": "Dit is een test",
        "introduction": "Test introduction",
        "content": "<p>Test content</p>",
        "external_id": "edition-traject-mz-kd2022"
      },
      "relationships": {
        "subjects": {}
      }
    }
  }'

Responses

Update modules

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: "Test content"

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 subjects

Request

Security

OAuth2

Path

modulestringrequired

Examples:

63fa853f-2769-4682-a0ec-600858474b26 63fa853f-2769-4682-a0ec-600858474b26

a6760ecb-20fe-4f34-bbde-bb5b4b68a18b a6760ecb-20fe-4f34-bbde-bb5b4b68a18b

6c163f9d-ea45-481b-964e-1c1c13401744 6c163f9d-ea45-481b-964e-1c1c13401744

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

Responses

ShowRelated modules

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

Show subjects relation

Request

Security

OAuth2

Path

modulestringrequired

Examples:

63fa853f-2769-4682-a0ec-600858474b26 63fa853f-2769-4682-a0ec-600858474b26

a6760ecb-20fe-4f34-bbde-bb5b4b68a18b a6760ecb-20fe-4f34-bbde-bb5b4b68a18b

6c163f9d-ea45-481b-964e-1c1c13401744 6c163f9d-ea45-481b-964e-1c1c13401744

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

Responses

Show modules

Bodyapplication/vnd.api+json

jsonapiobjectrequired

jsonapi.versionstring(version)

Example: "1.0"

dataArray of objects(Resource/Module/Relationship/Subjects/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": [
    { … }
  ]
}

Subjects

Operations

Chapters

Operations

The Learnspot API (1.0.0)

OAuth

Modules

Get all modules

Request

Responses

Was this helpful?

Store one module

Request

Responses

Was this helpful?

Show one module

Request

Responses

Was this helpful?

Update one module

Request

Responses

Was this helpful?

Show subjects

Request

Responses

Was this helpful?

Show subjects relation

Request

Responses

Was this helpful?

Subjects

Chapters

The Learnspot API (1.0.0)

OAuth

Modules

Get all modules

Request

Responses

Was this helpful?

Store one module

RequestExpand all

Responses

Was this helpful?

Show one module

Request

Responses

Was this helpful?

Update one module

RequestExpand all

Responses

Was this helpful?

Show subjects

Request

Responses

Was this helpful?

Show subjects relation

Request

Responses

Was this helpful?

Subjects

Chapters

Request

Request