Get Lms Course By Id - Bindbee Docs

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-connector-token

string

required

Path Parameters

string<uuid>

required

Query Parameters

include_raw_data

boolean

default:false

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

Example:

false

include_custom_fields

boolean

default:false

Whether to include custom fields in the response.

Example:

false

expand

string

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]"

Response

Successful Response

string<uuid>

required

Example:

"018b18ef-c487-703c-afd9-0ca478ccd9d6"

remote_id

string | null

required

The third-party API ID of the matching object.

Example:

"123321"

modified_at

string

required

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

Example:

"2021-10-16T00:00:00Z"

custom_fields

Custom Fields · object

required

The custom fields related to the model

Example:

{
  "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"
}

raw_data

Raw Data · object

This is the Raw data

Example:

{
  "key_1": "Platform dependent data 1",
  "key_2": "Platform dependent data 2"
}

name

string | null

The name of the course

Example:

"Python for Data Science"

description

string | null

The description of the course

Example:

"Introductory course"

cover_image

string | null

The URL of the cover image of the course

Example:

"https://img.example.com/py.png"

url

string | null

The URL of the course

Example:

"https://lms.example.com/course/py"

duration

string | null

The duration of the course in ISO 8601 format

Example:

"PT5H30M"

languages

enum<string>[]

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

Available options:

wae_CH,

ar_SY,

xh_ZA,

ar_EG,

fr_CH,

no_NO,

pt_PT,

hy_AM,

es_CR,

th_TH,

ks_IN,

ar_AA,

ik_CA,

wa_BE,

oc_FR,

en_EN,

tpi_PG,

miq_NI,

rw_RW,

bn_BD,

ka_GE,

ug_CN,

ta_LK,

ar_SS,

ru_UA,

ee_EE,

hsb_DE,

ar_MA,

nr_ZA,

sh_HR,

el_GR,

de_DE,

br_FR,

pap_CW,

quz_PE,

ar_QA,

the_NP,

is_IS,

es_NI,

hif_FJ,

csb_PL,

en_BW,

es_EC,

sw_TZ,

yue_HK,

st_ZA,

byn_ER,

ro_RO,

en_BE,

km_KH,

yi_US,

de_IT,

gv_GB,

aa_ER,

ss_ZA,

uk_UA,

it_IT,

nl_NL,

ti_ET,

hu_HU,

en_IE,

sl_SI,

ph_PH,

ar_TN,

de_BE,

ig_NG,

nso_ZA,

sc_IT,

ar_AE,

sid_ET,

fr_LU,

en_HK,

mni_IN,

es_AR,

sw_KE,

et_EE,

tr_TR,

nhn_MX,

ur_PK,

bo_CN,

mhr_RU,

li_BE,

ayc_PE,

so_KE,

niu_NU,

eo_XX,

lo_LA,

tl_PH,

so_SO,

lt_LT,

lv_LV,

cy_GB,

wo_SN,

it_CH,

ky_KG,

es_CO,

fy_NL,

iu_CA,

ar_YE,

en_ZW,

ca_FR,

ar_IQ,

gu_IN,

zh_HK,

iw_IL,

nb_NO,

ca_AD,

sa_IN,

tk_TM,

mg_MG,

ny_NO,

nan_TW,

wal_ET,

ru_RU,

mag_IN,

to_TO,

tcy_IN,

bg_BG,

sgs_LT,

pd_US,

ja_JP,

an_ES,

pap_AW,

fi_FI,

en_NZ,

ia_FR,

en_ZS,

vi_VN,

kl_GL,

sv_FI,

gez_ET,

es_US,

tt_RU,

en_AG,

si_LK,

eo_US,

or_IN,

hak_TW,

sm_WS,

en_SC,

es_UY,

he_IL,

da_DK,

es_PA,

ff_SN,

es_BO,

hi_IN,

sr_ME,

gd_GB,

tig_ER,

shs_CA,

mi_NZ,

te_IN,

mai_IN,

unm_US,

ht_HT,

id_ID,

zh_CN,

fur_IT,

en_ZA,

nds_DE,

be_BY,

niu_NZ,

ga_IE,

bho_IN,

fr_CA,

mr_IN,

sk_SK,

shn_MM,

raj_IN,

es_CU,

se_NO,

es_VE,

sd_IN,

fil_PH,

mai_NP,

dv_MV,

bem_ZM,

bho_NP,

zh_TW,

crh_UA,

lb_LU,

eo,

es_PE,

sr_CS,

aa_ET,

zu_ZA,

de_LI,

en_PH,

C,

ber_DZ,

en_IL,

de_AT,

my_MM,

gez_ER,

en_NG,

en_DL,

sv_SE,

ca_IT,

sr_RS,

lij_IT,

ku_TR,

ak_GH,

en_AU,

ti_ER,

brx_IN,

so_DJ,

ms_MY,

os_RU,

pa_IN,

ar_SA,

ta_IN,

ar_LY,

eo_EO,

eu_ES,

es_PR,

chr_US,

ar_OM,

yuw_PG,

ha_NG,

sl_CS,

gl_ES,

mn_MN,

mjw_IN,

es_DO,

lg_UG,

ps_AF,

el_CY,

mk_MK,

pt_BR,

sd_PK,

ar_BH,

eu_FR,

agr_PE,

ln_CD,

fa_IR,

ber_MA,

ar_SD,

en_GB,

es_ES,

ar_JO,

es_HN,

li_NL,

sq_MK,

mt_MT,

fr_FR,

az_AZ,

uz_UZ,

af_ZA,

bn_IN,

szl_PL,

lzh_TW,

doi_IN,

zh_SG,

kn_IN,

bi_VU,

nl_BE,

bs_BA,

kok_IN,

bhb_IN,

ca_ES,

so_ET,

tg_TJ,

de_CH,

de_LU,

mfe_MU,

cv_RU,

pl_PL,

om_KE,

tr_CY,

yo_NG,

nl_AW,

nn_NO,

as_IN,

ar_IN,

nds_NL,

ts_ZA,

pa_PK,

tn_ZA,

pap_AN,

es_PY,

cs_CZ,

fr_BE,

ar_KW,

ce_RU,

ml_IN,

es_GT,

kw_GB,

aa_DJ,

ckb_IQ,

fy_DE,

ur_IN,

es_CL,

ve_ZA,

en_SG,

ko_KR,

sq_AL,

cmn_TW,

en_CA,

en_IN,

en_ZM,

bo_IN,

anp_IN,

hr_HR,

ia,

om_ET,

sat_IN,

es_MX,

ast_ES,

en_US,

ar_LB,

fo_FO,

am_ET,

az_IR,

pp_AN,

ne_NP,

ar_DZ,

es_SV,

kab_DZ,

hne_IN,

en_DK,

dz_BT,

pd_DE,

kk_KZ

Example:

["en_US", "fr_FR"]

Unified Models

Authorizations

Headers

Path Parameters

Query Parameters

Response