GET restapi/personal/courses/{courseId}/participants/unenrolled/v1?PageIndex={PageIndex}&PageSize={PageSize}&searchText={searchText}&orderByField={orderByField}&orderAscending={orderAscending}&dropDateFrom={dropDateFrom}

Gets a list of the unenrolled course participants for a given course.

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId	The id of the course we want the participants from	integer	Required
PageIndex		integer	None.
PageSize		integer	None.
searchText	[OPTIONAL] The text to search for	string	None.
orderByField	[OPTIONAL] The field to sort by.Defaults to fullname. Example usage ?orderbyfield=droppeddt	string	Default value is fullName
orderAscending	[OPTIONAL] Whether we should sort ascending or not. Example usage ?orderAscending=false	boolean	Default value is True
dropDateFrom	[OPTIONAL] The field to filter participants by date when they are dropped.	date	None.

Body Parameters

None.

Response Information

Resource Description

EntityListOfItslearning.RestApi.Entities.Personal.Course.CourseParticipantUnenrolled

Name	Type	Additional information
EntityArray	Collection of Itslearning.RestApi.Entities.Personal.Course.CourseParticipantUnenrolled	None.
Total	integer	None.
CurrentPageIndex	integer	None.
PageSize	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "PersonId": 1,
      "FullName": "sample string 2",
      "TemporaryAccess": true,
      "DateUnenrolled": "2025-06-23T10:54:37Z",
      "DateUnenrolledRelative": "sample string 4",
      "MemberOfCourseGroups": "sample string 5",
      "PictureUrl": "sample string 6",
      "AssessmentUrl": "sample string 7",
      "ExtraInformation": "sample string 8"
    },
    {
      "PersonId": 1,
      "FullName": "sample string 2",
      "TemporaryAccess": true,
      "DateUnenrolled": "2025-06-23T10:54:37Z",
      "DateUnenrolledRelative": "sample string 4",
      "MemberOfCourseGroups": "sample string 5",
      "PictureUrl": "sample string 6",
      "AssessmentUrl": "sample string 7",
      "ExtraInformation": "sample string 8"
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:

<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <CourseParticipantUnenrolled>
      <AssessmentUrl>sample string 7</AssessmentUrl>
      <DateUnenrolled>2025-06-23T10:54:37Z</DateUnenrolled>
      <DateUnenrolledRelative>sample string 4</DateUnenrolledRelative>
      <ExtraInformation>sample string 8</ExtraInformation>
      <FullName>sample string 2</FullName>
      <MemberOfCourseGroups>sample string 5</MemberOfCourseGroups>
      <PersonId>1</PersonId>
      <PictureUrl>sample string 6</PictureUrl>
      <TemporaryAccess>true</TemporaryAccess>
    </CourseParticipantUnenrolled>
    <CourseParticipantUnenrolled>
      <AssessmentUrl>sample string 7</AssessmentUrl>
      <DateUnenrolled>2025-06-23T10:54:37Z</DateUnenrolled>
      <DateUnenrolledRelative>sample string 4</DateUnenrolledRelative>
      <ExtraInformation>sample string 8</ExtraInformation>
      <FullName>sample string 2</FullName>
      <MemberOfCourseGroups>sample string 5</MemberOfCourseGroups>
      <PersonId>1</PersonId>
      <PictureUrl>sample string 6</PictureUrl>
      <TemporaryAccess>true</TemporaryAccess>
    </CourseParticipantUnenrolled>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>