GET restapi/personal/workload/course/{courseId}/v1?PageIndex={PageIndex}&PageSize={PageSize}

Gets a list of students in a specified course with corresponding workload.

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId	The id of the requested course	integer	Required
PageIndex		integer	None.
PageSize		integer	None.

Body Parameters

None.

Response Information

Resource Description

This method returns a collection of entity . Each entity contains the details of a student and their workload.

EntityListOfItslearning.RestApi.Entities.PersonSimpleWithWorkload

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

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "Workload": {
        "FinishedAssignments": 1,
        "TotalAvailableAssignments": 2,
        "FinishedWorkload": 3,
        "TotalAvailableWorkload": 4
      },
      "PersonId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "ProfileUrl": "sample string 5",
      "AdditionalInfo": "sample string 6",
      "ProfileImageUrl": "sample string 7",
      "ProfileImageUrlSmall": "sample string 8"
    },
    {
      "Workload": {
        "FinishedAssignments": 1,
        "TotalAvailableAssignments": 2,
        "FinishedWorkload": 3,
        "TotalAvailableWorkload": 4
      },
      "PersonId": 1,
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "FullName": "sample string 4",
      "ProfileUrl": "sample string 5",
      "AdditionalInfo": "sample string 6",
      "ProfileImageUrl": "sample string 7",
      "ProfileImageUrlSmall": "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>
    <PersonSimpleWithWorkload>
      <AdditionalInfo>sample string 6</AdditionalInfo>
      <FirstName>sample string 2</FirstName>
      <FullName>sample string 4</FullName>
      <LastName>sample string 3</LastName>
      <PersonId>1</PersonId>
      <ProfileImageUrl>sample string 7</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
      <ProfileUrl>sample string 5</ProfileUrl>
      <Workload>
        <FinishedAssignments>1</FinishedAssignments>
        <FinishedWorkload>3</FinishedWorkload>
        <TotalAvailableAssignments>2</TotalAvailableAssignments>
        <TotalAvailableWorkload>4</TotalAvailableWorkload>
      </Workload>
    </PersonSimpleWithWorkload>
    <PersonSimpleWithWorkload>
      <AdditionalInfo>sample string 6</AdditionalInfo>
      <FirstName>sample string 2</FirstName>
      <FullName>sample string 4</FullName>
      <LastName>sample string 3</LastName>
      <PersonId>1</PersonId>
      <ProfileImageUrl>sample string 7</ProfileImageUrl>
      <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
      <ProfileUrl>sample string 5</ProfileUrl>
      <Workload>
        <FinishedAssignments>1</FinishedAssignments>
        <FinishedWorkload>3</FinishedWorkload>
        <TotalAvailableAssignments>2</TotalAvailableAssignments>
        <TotalAvailableWorkload>4</TotalAvailableWorkload>
      </Workload>
    </PersonSimpleWithWorkload>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>