Get Course Custom Fields

Get all course custom fields and related field attributes.

Request URI 

GET /coursecustomfields?

Response Body (XML)

<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>
        </Dropdown>
    </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 the Details for a Specific Course Custom Field

Get the details of a specific course custom field.

Request URI 

GET /coursecustomfields/{customfieldId}?

Response Body (XML)

<CourseCustomField>
    <CustomFieldId>string [max length 50]</CustomFieldId>
    <Label>string [max length 100]</Label>
    <DefaultValue>OneOf: string, integer, date-time, drop-down</DefaultValue>
    <Mandatory>true/false</Mandatory>
    <VisibleToLearner>true/false</VisibleToLearner>
    <Type>OneOf: string, integer, date-time, drop-down</Type>
    <Dropdown/>
</CourseCustomField>

Get All Custom Field Values for a Course

Get the course custom field values for a specific course record.

Request URI 

GET /courses/{courseid}/coursecustomfields?

Response Body (XML)

<ArrayOfparameter>
    <parameter>
        <fieldname>string [max length 100]</fieldname>
        <value>OneOf: string, integer, date-time, drop-down</value>
    </parameter>
    <parameter>
        <fieldname>string [max length 100]</fieldname>
        <value>OneOf: string, integer, date-time, drop-down</value>
    </parameter>
</ArrayOfparameter>