Claromentis API Docs logoClaromentis API Docs

Claromentis Learning API v1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Rest API for Claromentis Learning module

Base URLs:

Email: Discover Claromentis Web: Discover Claromentis

Authentication

  • HTTP Authentication, scheme: basic

Learning

Claromentis Learning module

List of the learning history records

Method: GET

Path: /history

The list of the records in module Learning

Parameters

Name In Type Required Description
start query integer false Offset for pagination (starting index)
limit query integer false Maximum number of results to return
filter query integer false Filter by type IDs (Default: 115, Path: 116, Certificate: 117).

Enumerated Values

Parameter Value
filter 115
filter 116
filter 117

Example responses

Status Code 200

{
  "history": [
    {
      "id": 123,
      "date": {
        "date": "25 November 2024"
      },
      "title": "Course 1",
      "code": "COURSE-1",
      "type": "E-learning",
      "type_id": 101,
      "icon": "glyphicons-cup",
      "color": "record-bg",
      "view_link": "/training-record/1212",
      "edit_link": "/training-record/1212/edit",
      "show_certificate": false,
      "raw_date": "20240816",
      "is_future": false
    }
  ],
  "total": 0,
  "user": "123",
  "can_modify": true
}

Responses

Status Meaning Description Schema
200 OK The list of the records from learning Inline
401 Unauthorized Authentication is required Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» history [History] false none [Training record data]
»» id integer false read-only ID of the project
»» date object false none Date object
»»» date string(date-time) false read-only The field contains date
»» title string false read-only Course title
»» code string false read-only Course code
»» type string false read-only Course type
»» type_id integer false read-only Course type ID
»» icon string false read-only Course icon
»» color string false read-only Course color
»» view_link string false read-only The link to the course
»» edit_link string false read-only The link to the edit course
»» show_certificate boolean false read-only Flag if show certificate
»» raw_date string false read-only Unformatted date value
»» is_future boolean false read-only Flag if that record is future record
» total integer false none The number of returned items
» user integer false none The user ID
» can_modify boolean false none The flag if the user can modified

Status Code 401

Authentication is required

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

List of the learning history records by user ID

Method: GET

Path: /history/{user-id}

The list of the records in module Learning filtered by user ID

Parameters

Name In Type Required Description
user-id path integer true User ID
start query integer false Offset for pagination (starting index)
limit query integer false Maximum number of results to return
filter query integer false Filter by type IDs (Default: 115, Path: 116, Certificate: 117).

Enumerated Values

Parameter Value
filter 115
filter 116
filter 117

Example responses

200 Response

{
  "history": [
    {
      "id": 123,
      "date": {
        "date": "25 November 2024"
      },
      "title": "Course 1",
      "code": "COURSE-1",
      "type": "E-learning",
      "type_id": 101,
      "icon": "glyphicons-cup",
      "color": "record-bg",
      "view_link": "/training-record/1212",
      "edit_link": "/training-record/1212/edit",
      "show_certificate": false,
      "raw_date": "20240816",
      "is_future": false
    }
  ],
  "total": 0,
  "user": "123",
  "can_modify": true
}

Responses

Status Meaning Description Schema
200 OK The list of the records from learning Inline
401 Unauthorized Authentication is required Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
» history [History] false none [Training record data]
»» id integer false read-only ID of the project
»» date object false none Date object
»»» date string(date-time) false read-only The field contains date
»» title string false read-only Course title
»» code string false read-only Course code
»» type string false read-only Course type
»» type_id integer false read-only Course type ID
»» icon string false read-only Course icon
»» color string false read-only Course color
»» view_link string false read-only The link to the course
»» edit_link string false read-only The link to the edit course
»» show_certificate boolean false read-only Flag if show certificate
»» raw_date string false read-only Unformatted date value
»» is_future boolean false read-only Flag if that record is future record
» total integer false none The number of returned items
» user integer false none The user ID
» can_modify boolean false none The flag if the user can modified

Status Code 401

Authentication is required

Name Type Required Restrictions Description
» error boolean false read-only The error flag
» message string false read-only The error message
» code integer false read-only The HTTP response status code

Schemas

date

{
  "date": "25 November 2024"
}

Date object

Properties

Name Type Required Restrictions Description
date string(date-time) false read-only The field contains date

History

{
  "id": 123,
  "date": {
    "date": "25 November 2024"
  },
  "title": "Course 1",
  "code": "COURSE-1",
  "type": "E-learning",
  "type_id": 101,
  "icon": "glyphicons-cup",
  "color": "record-bg",
  "view_link": "/training-record/1212",
  "edit_link": "/training-record/1212/edit",
  "show_certificate": false,
  "raw_date": "20240816",
  "is_future": false
}

Training record data

Properties

Name Type Required Restrictions Description
id integer false read-only ID of the project
date date false none Date object
title string false read-only Course title
code string false read-only Course code
type string false read-only Course type
type_id integer false read-only Course type ID
icon string false read-only Course icon
color string false read-only Course color
view_link string false read-only The link to the course
edit_link string false read-only The link to the edit course
show_certificate boolean false read-only Flag if show certificate
raw_date string false read-only Unformatted date value
is_future boolean false read-only Flag if that record is future record