GET restapi/personal/courses/{courseId}/students/v1?pageIndex={pageIndex}&pageSize={pageSize}&search={search}

Get students in course

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId	Course Id	integer	Required
pageIndex	Page index for pagination	integer	Default value is 0
pageSize	Number of items per page	integer	Default value is 100
search	Search filter	string	None.

Body Parameters

None.

Response Information

Resource Description

Itsolutions.Itslearning.Web.RestApi.Personal.ContentAreaSettings.Models.ParticipantsModel

Name	Description	Type	Additional information
Participants	The array of participant items.	Collection of Itsolutions.Itslearning.Web.RestApi.Personal.ContentAreaSettings.Models.ParticipantItemModel	None.
TotalCount	The total count of participants available.	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Participants": [
    {
      "PersonId": 1,
      "FullName": "sample string 2",
      "ExtraInformation": "sample string 3",
      "PictureUrl": "sample string 4"
    },
    {
      "PersonId": 1,
      "FullName": "sample string 2",
      "ExtraInformation": "sample string 3",
      "PictureUrl": "sample string 4"
    }
  ],
  "TotalCount": 1
}

application/xml, text/xml

Sample:

<ParticipantsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itsolutions.Itslearning.Web.RestApi.Personal.ContentAreaSettings.Models">
  <Participants>
    <ParticipantItemModel>
      <ExtraInformation>sample string 3</ExtraInformation>
      <FullName>sample string 2</FullName>
      <PersonId>1</PersonId>
      <PictureUrl>sample string 4</PictureUrl>
    </ParticipantItemModel>
    <ParticipantItemModel>
      <ExtraInformation>sample string 3</ExtraInformation>
      <FullName>sample string 2</FullName>
      <PersonId>1</PersonId>
      <PictureUrl>sample string 4</PictureUrl>
    </ParticipantItemModel>
  </Participants>
  <TotalCount>1</TotalCount>
</ParticipantsModel>