POST api/Courses/RetrieveCourseEnrollments
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of vw_current_course_enrolment| Name | Description | Type | Additional information |
|---|---|---|---|
| status | integer |
None. |
|
| userid | integer |
None. |
|
| firstname | string |
None. |
|
| lastname | string |
None. |
|
| enrolid | integer |
None. |
|
| enrolled | date |
None. |
|
| ending | date |
None. |
|
| timeend | integer |
None. |
|
| courseid | integer |
None. |
|
| enrol | string |
None. |
|
| shortname | string |
None. |
|
| category | integer |
None. |
|
| roleid | integer |
None. |
|
| course_type | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"status": 1,
"userid": 2,
"firstname": "sample string 3",
"lastname": "sample string 4",
"enrolid": 5,
"enrolled": "2025-10-24T13:04:07.9761179+01:00",
"ending": "2025-10-24T13:04:07.9761179+01:00",
"timeend": 6,
"courseid": 7,
"enrol": "sample string 8",
"shortname": "sample string 9",
"category": 10,
"roleid": 1,
"course_type": "sample string 11"
},
{
"status": 1,
"userid": 2,
"firstname": "sample string 3",
"lastname": "sample string 4",
"enrolid": 5,
"enrolled": "2025-10-24T13:04:07.9761179+01:00",
"ending": "2025-10-24T13:04:07.9761179+01:00",
"timeend": 6,
"courseid": 7,
"enrol": "sample string 8",
"shortname": "sample string 9",
"category": 10,
"roleid": 1,
"course_type": "sample string 11"
}
]
application/xml, text/xml
Sample:
<ArrayOfvw_current_course_enrolment xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Totara.WEBAPI">
<vw_current_course_enrolment>
<category>10</category>
<course_type>sample string 11</course_type>
<courseid>7</courseid>
<ending>2025-10-24T13:04:07.9761179+01:00</ending>
<enrol>sample string 8</enrol>
<enrolid>5</enrolid>
<enrolled>2025-10-24T13:04:07.9761179+01:00</enrolled>
<firstname>sample string 3</firstname>
<lastname>sample string 4</lastname>
<roleid>1</roleid>
<shortname>sample string 9</shortname>
<status>1</status>
<timeend>6</timeend>
<userid>2</userid>
</vw_current_course_enrolment>
<vw_current_course_enrolment>
<category>10</category>
<course_type>sample string 11</course_type>
<courseid>7</courseid>
<ending>2025-10-24T13:04:07.9761179+01:00</ending>
<enrol>sample string 8</enrol>
<enrolid>5</enrolid>
<enrolled>2025-10-24T13:04:07.9761179+01:00</enrolled>
<firstname>sample string 3</firstname>
<lastname>sample string 4</lastname>
<roleid>1</roleid>
<shortname>sample string 9</shortname>
<status>1</status>
<timeend>6</timeend>
<userid>2</userid>
</vw_current_course_enrolment>
</ArrayOfvw_current_course_enrolment>