Certifications

Certificate generation and management for course completion.

Create certification

POST/api/v1/certifications/

API tokencertifications:createor user session

Create a new certification template for a course. Certifications are awarded when a learner completes the course.

Request bodyapplication/jsonrequired

course_idintegerrequired

configConfig

Returns

CertificationRead — Certification created.

idintegerrequired

certification_uuidstringrequired

course_idintegerrequired

configConfigrequired

creation_datestringrequired

update_datestringrequired

Error responses

403 Caller lacks permission to create certifications on this course
404 Course not found
422 Validation Error — HTTPValidationError

Request

Response

{
  "id": 1,
  "certification_uuid": "string",
  "course_id": 1,
  "config": {},
  "creation_date": "string",
  "update_date": "string"
}

Get certification

GET/api/v1/certifications/{certification_uuid}

API tokencertifications:reador user session

Get a single certification template by its UUID.

Path parameters

certification_uuidstringrequired

Returns

CertificationRead — Certification details.

idintegerrequired

certification_uuidstringrequired

course_idintegerrequired

configConfigrequired

creation_datestringrequired

update_datestringrequired

Error responses

404 Certification not found
422 Validation Error — HTTPValidationError

Request

Response

{
  "id": 1,
  "certification_uuid": "string",
  "course_id": 1,
  "config": {},
  "creation_date": "string",
  "update_date": "string"
}

Update certification

PUT/api/v1/certifications/{certification_uuid}

API tokencertifications:updateor user session

Update a certification template by its UUID.

Path parameters

certification_uuidstringrequired

Request bodyapplication/jsonrequired

configConfig | null

Returns

CertificationRead — Certification updated.

idintegerrequired

certification_uuidstringrequired

course_idintegerrequired

configConfigrequired

creation_datestringrequired

update_datestringrequired

Error responses

403 Caller lacks permission to update this certification
404 Certification not found
422 Validation Error — HTTPValidationError

Request

Response

{
  "id": 1,
  "certification_uuid": "string",
  "course_id": 1,
  "config": {},
  "creation_date": "string",
  "update_date": "string"
}

Delete certification

DELETE/api/v1/certifications/{certification_uuid}

API tokencertifications:deleteor user session

Delete a certification template by its UUID. Existing awarded certificates are not removed.

Path parameters

certification_uuidstringrequired

Error responses

403 Caller lacks permission to delete this certification
404 Certification not found
422 Validation Error — HTTPValidationError

Request

Response

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

List course certifications

GET/api/v1/certifications/course/{course_uuid}

API tokencertifications:reador user session

Get all certification templates attached to a course.

Path parameters

course_uuidstringrequired

Returns

CertificationRead[] — List of certifications for the course.

idintegerrequired

certification_uuidstringrequired

course_idintegerrequired

configConfigrequired

creation_datestringrequired

update_datestringrequired

Error responses

404 Course not found
422 Validation Error — HTTPValidationError

Request

Response

[
  {
    "id": 1,
    "certification_uuid": "string",
    "course_id": 1,
    "config": {},
    "creation_date": "string",
    "update_date": "string"
  }
]

List my certificates for course

GET/api/v1/certifications/user/course/{course_uuid}

API tokencertifications:reador user session

Get all certificates awarded to the current user for a specific course, including certification details.

Path parameters

course_uuidstringrequired

Error responses

404 Course not found
422 Validation Error — HTTPValidationError

Request

Response

[
  {}
]

Get awarded certificate

GET/api/v1/certifications/certificate/{user_certification_uuid}

API tokencertifications:reador user session

Get an awarded certificate by its user_certification UUID, with linked certification and course details.

Path parameters

user_certification_uuidstringrequired

Error responses

404 Certificate not found
422 Validation Error — HTTPValidationError

Request

Response

{}

List my certificates

GET/api/v1/certifications/user/all

API tokencertifications:reador user session

Get every certificate awarded to the current user across all courses, with complete linked information.

Request

Response

[
  {}
]