Badges

Learning API Demo (v1)

This is a mock API. It is for demo and learning purposes. The server URL is powered by a Remockly mock server. You can send curl requests and use the try it console to interact with the mock API.

Download OpenAPI description
openapi.json
openapi.yaml
Overview

Terms of Service

Languages
Servers
Mock server

https://innovario.apishowdown.com/_mock/cicd-repo/openapi/

https://api.impossiblemissionsforce.com/

Activities

Endpoints related to learning activities, such as lessons, videos, and interactive exercises. Use these APIs to create, update, retrieve, and delete learning activities.

Operations

Quizzes

Endpoints for managing quizzes and quiz questions. These APIs enable you to create, update, retrieve, and delete quizzes, as well as manage questions and options within quizzes.

Operations

Badges

Endpoints for badge management, including creating, updating, retrieving, and deleting badges. Badges are awarded to learners based on their performance or progress in the learning system.

Operations

Create badge

Request

Bodyapplication/json
namestring
iconstring
requirementsArray of objects
createdAtstring(date-time)
updatedAtstring(date-time)
curl -i -X POST \
  https://innovario.apishowdown.com/_mock/cicd-repo/openapi/badges \
  -H 'Content-Type: application/json' \
  -H 'IMF-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "Explorer",
    "icon": "/images/explorer-icon.png",
    "requirements": [
      {
        "type": "quiz",
        "name": "Who we are",
        "minScore": 0.85,
        "maxAttempts": 1,
        "status": "done"
      }
    ],
    "createdAt": "2023-02-19T11:21:36Z",
    "updatedAt": "2023-02-19T11:21:36Z"
  }'

Responses

Created.

Bodyapplication/json
idstringread-only
namestring
iconstring
requirementsArray of objects
createdAtstring(date-time)
updatedAtstring(date-time)
Response
application/json
{
  "id": "badge_abc987def123",
  "name": "Explorer",
  "icon": "/images/explorer-icon.png",
  "requirements": [
    { … }
  ],
  "createdAt": "2023-02-19T11:21:36Z",
  "updatedAt": "2023-02-19T11:21:36Z"
}

Get badges

Request

curl -i -X GET \
  https://innovario.apishowdown.com/_mock/cicd-repo/openapi/badges \
  -H 'IMF-KEY: YOUR_API_KEY_HERE'

Responses

Retrieved.

Bodyapplication/jsonArray [
idstringread-only
namestring
iconstring
requirementsArray of objects
createdAtstring(date-time)
updatedAtstring(date-time)
]
Response
application/json
[
  {
    "id": "badge_abc987def123",
    "name": "Explorer",
    "icon": "/images/explorer-icon.png",
    "requirements": [ … ],
    "createdAt": "2023-02-19T11:21:36Z",
    "updatedAt": "2023-02-19T11:21:36Z"
  }
]

Scores

Endpoints for handling learner scores on quizzes, activities, and assignments. Use these APIs to submit, retrieve, update, and delete scores for individual learners or groups.

Operations

Checklists

Endpoints for managing checklists, which are lists of tasks or objectives learners must complete. These APIs enable you to create, update, retrieve, and delete checklists, as well as manage checklist items.

Operations

Assignments

Endpoints related to assignments, including creating, updating, retrieving, and deleting assignments. Assignments may include projects, essays, or other tasks that learners are required to complete.

Operations

Reports

Endpoints for generating and retrieving reports on learner progress, activity completion, and overall performance. Use these APIs to access and analyze data on individual learners or groups, as well as export reports for further analysis.

Operations

Other

Other endpoints are described here.

Operations