Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Courses

Get Lms Course By Id

Returns an LMS Course object with the given id.

get/api/lms/v1/courses/{id}

Path parameters

idstring uuid required

Query parameters

include_raw_databoolean

Whether to include the original data Bindbee fetched from the third-party to produce these models.

Whether to include the original data Bindbee fetched from the third-party to produce these models.

include_custom_fieldsboolean

Whether to include custom fields in the response.

Whether to include custom fields in the response.

expandstring

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Example:manager[first_name,last_name]

Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.

Headers

x-connector-tokenstring required

Response

Successful Response

idstring uuid required
remote_idstring nullable required

The third-party API ID of the matching object.

modified_atstring required

This is the datetime that this object was last updated by Bindbee

raw_dataobject nullable

This is the Raw data

custom_fieldsobject nullable required

The custom fields related to the model

namestring nullable

The name of the course

descriptionstring nullable

The description of the course

cover_imagestring nullable

The URL of the cover image of the course

urlstring nullable

The URL of the course

durationstring nullable

The duration of the course in ISO 8601 format

languagesstring[] nullable

The languages of the course as locale codes (e.g. en_US, fr_FR, de_DE).

status'ACTIVE' | 'PENDING' | 'INACTIVE' nullable

The status of the course. If the value is not one of the defined enum values, the original value passed through will be returned.

Example response

{
  "id": "018b18ef-c487-703c-afd9-0ca478ccd9d6",
  "remote_id": "123321",
  "modified_at": "2021-10-16T00:00:00Z",
  "raw_data": {
    "key_1": "Platform dependent data 1",
    "key_2": "Platform dependent data 2"
  },
  "custom_fields": {
    "category_group": "REG",
    "disability_type": "ASBERG",
    "hire_date": "1991-03-16T00:00:00",
    "hire_source": "REFER",
    "nationality": "USA",
    "original_hire_date": "1991-03-16T00:00:00"
  },
  "name": "Python for Data Science",
  "description": "Introductory course",
  "cover_image": "https://img.example.com/py.png",
  "url": "https://lms.example.com/course/py",
  "duration": "PT5H30M",
  "languages": [
    "en_US",
    "fr_FR"
  ],
  "status": "ACTIVE"
}