Litmos Support

Getting Started
Knowledgebase
Community

Articles in this section

See more

Course Custom Fields (API) - Get a list of Custom Course Fields for Courses

Avatar
Madeline
  • Updated
Follow

The following requests relate to retrieving custom Course fields via the Litmos API.

Note: All requests must be Authenticated. 

Get All course custom fields

Lists all Custom Fields that appear for all courses and their attrabutes

Request Uri

GET /coursecustomfields

Request Body

<CourseCustomFields>
  <CourseCustomField>
    <CustomFieldId>string [max length 50]</CustomFieldId>
    <Label>string</Label>
    <DefaultValue></DefaultValue>
    <Mandatory>true/false</Mandatory>
    <VisibleToLearner>true/false</VisibleToLearner>
    <Type></Type>
    <Dropdown>
      <DropdownId></DropdownId
      <DropdownValue></DropdownValue>    
  </CourseCustomField>
  <CourseCustomField>
    <CustomFieldId>string [max length 50]</CustomFieldId>
    <Label>string</Label>
    <DefaultValue></DefaultValue>
    <Mandatory>true/false</Mandatory>
    <VisibleToLearner>true/false</VisibleToLearner>
    <Type></Type>
    <Dropdown/>
  </CourseCustomField>
...
</CourseCustomFields>

Get Course custom field details based on custom field Id

Retrieve a single Custom Field that appears for all courses and the Custom Field's attributes.

Request Uri

GET coursecustomfields/{CustomFieldId}

Request Body

<CourseCustomField>
  <CustomFieldId>string [max length 50]</CustomFieldId>
  <Label>string</Label>
  <DefaultValue>string</DefaultValue>
  <Mandatory>true/false</Mandatory>
  <VisibleToLearner>true/false</VisibleToLearner>
  <Type>String</Type>
  <Dropdown/>
</CourseCustomField>
 

Get custom fields for a course

Request Uri

GET courses/{CourseId}/coursecustomfields

Request Body

<CustomFields>
  <parameter>
    <Parameter fieldname="{field_name}">string</Parameter>
    <Parameter fieldname="{field_name}"/>
   ...
 </parameter>
</CustomFields>

 

Related articles

Comments

0 comments

Please sign in to leave a comment.