Skip to content

API: Content tagging endpoints

/tags

GET /tags

List owned and managed tags.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/tag

GET /tag

Get/check tag.

[] Input:

  • [!] string tag: tag identification string

[] Output:

  • string tag: tag identification string
  • string name: title of the tag
  • string color: color in HEX format
  • string icon: Font Awesome icon class name

/class:tags

GET /class:tags

List all attached tags of a class.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/class:tag

GET /class:tag

Check if tag is attached to a class.

[] Input:

  • [!] string class: class identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be class
    • string code: the class identification string
  • boolean status: tag is attached to this class

POST /class:tag

Attach tag to content.

[] Input:

  • [!] string class: class identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be class
    • string code: the class identification string
  • boolean success: operation was successful

DELETE /class:tag

Remove a tag attachment.

[] Input:

  • [!] string class: class identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be class
    • string code: the class identification string
  • boolean success: operation was successful

/course:tags

GET /course:tags

List all attached tags of a course.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/course:tag

GET /course:tag

Check if tag is attached to a course.

[] Input:

  • [!] string course: course identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be course
    • string code: the course identification string
  • boolean status: tag is attached to this course

POST /course:tag

Attach tag to content.

[] Input:

  • [!] string course: course identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be course
    • string code: the course identification string
  • boolean success: operation was successful

DELETE /course:tag

Remove a tag attachment.

[] Input:

  • [!] string course: course identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be course
    • string code: the course identification string
  • boolean success: operation was successful

/event:tags

GET /event:tags

List all attached tags of an event.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/event:tag

GET /event:tag

Check if tag is attached to an event.

[] Input:

  • [!] string event: event identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be event
    • string code: the event identification string
  • boolean status: tag is attached to this event

POST /event:tag

Attach tag to content.

[] Input:

  • [!] string event: event identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be event
    • string code: the event identification string
  • boolean success: operation was successful

DELETE /event:tag

Remove a tag attachment.

[] Input:

  • [!] string event: event identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be event
    • string code: the event identification string
  • boolean success: operation was successful

/exam:tags

GET /exam:tags

List all attached tags of an exam.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/exam:tag

GET /exam:tag

Check if tag is attached to an exam.

[] Input:

  • [!] string exam: exam identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be exam
    • string code: the exam identification string
  • boolean status: tag is attached to this exam

POST /exam:tag

Attach tag to content.

[] Input:

  • [!] string exam: exam identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be exam
    • string code: the exam identification string
  • boolean success: operation was successful

DELETE /exam:tag

Remove a tag attachment.

[] Input:

  • [!] string exam: exam identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be exam
    • string code: the exam identification string
  • boolean success: operation was successful

/integration:tags

GET /integration:tags

List all attached tags of an integration.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/integration:tag

GET /integration:tag

Check if tag is attached to an integration.

[] Input:

  • [!] string integration: integration identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be integration
    • string code: the integration identification string
  • boolean status: tag is attached to this integration

POST /integration:tag

Attach tag to content.

[] Input:

  • [!] string integration: integration identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be integration
    • string code: the integration identification string
  • boolean success: operation was successful

DELETE /integration:tag

Remove a tag attachment.

[] Input:

  • [!] string integration: integration identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be integration
    • string code: the integration identification string
  • boolean success: operation was successful

/organization:tags

GET /organization:tags

List all attached tags of an organization.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/organization:tag

GET /organization:tag

Check if tag is attached to an organization.

[] Input:

  • [!] string organization: organization identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be organization
    • string code: the organization identification string
  • boolean status: tag is attached to this organization

POST /organization:tag

Attach tag to content.

[] Input:

  • [!] string organization: organization identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be organization
    • string code: the organization identification string
  • boolean success: operation was successful

DELETE /organization:tag

Remove a tag attachment.

[] Input:

  • [!] string organization: organization identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be organization
    • string code: the organization identification string
  • boolean success: operation was successful

/quiz:tags

GET /quiz:tags

List all attached tags of a Quiz.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/quiz:tag

GET /quiz:tag

Check if tag is attached to a Quiz.

[] Input:

  • [!] string quiz: Quiz identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be quiz
    • string code: the Quiz identification string
  • boolean status: tag is attached to this Quiz

POST /quiz:tag

Attach tag to content.

[] Input:

  • [!] string quiz: Quiz identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be quiz
    • string code: the Quiz identification string
  • boolean success: operation was successful

DELETE /quiz:tag

Remove a tag attachment.

[] Input:

  • [!] string quiz: Quiz identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be quiz
    • string code: the Quiz identification string
  • boolean success: operation was successful

/scorm:tags

GET /scorm:tags

List all attached tags of a SCORM learning material.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/scorm:tag

GET /scorm:tag

Check if tag is attached to a SCORM learning material.

[] Input:

  • [!] string scorm: SCORM identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be scorm
    • string code: the SCORM identification string
  • boolean status: tag is attached to this SCORM learning material

POST /scorm:tag

Attach tag to content.

[] Input:

  • [!] string scorm: SCORM identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be scorm
    • string code: the SCORM identification string
  • boolean success: operation was successful

DELETE /scorm:tag

Remove a tag attachment.

[] Input:

  • [!] string scorm: SCORM identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be scorm
    • string code: the SCORM identification string
  • boolean success: operation was successful

/video:tags

GET /video:tags

List all attached tags of a video.

[] Output:

  • list
    • string code: tag identification string
    • string name: title of the tag

/video:tag

GET /video:tag

Check if tag is attached to a video.

[] Input:

  • [!] string video: video identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be video
    • string code: the video identification string
  • boolean status: tag is attached to this video

POST /video:tag

Attach tag to content.

[] Input:

  • [!] string video: video identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be video
    • string code: the video identification string
  • boolean success: operation was successful

DELETE /video:tag

Remove a tag attachment.

[] Input:

  • [!] string video: video identification string
  • [!] string tag: tag identification string

[] Output:

  • string tag: the tag identification string
  • content
    • string type: will be video
    • string code: the video identification string
  • boolean success: operation was successful