GET restapi/personal/courses/{courseId}/applicants/v1

Request Information

URI Parameters

Name	Description	Type	Additional information
courseId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Itslearning.RestApi.Entities.Personal.Course.CourseApplicant

Name	Description	Type	Additional information
PersonId	The id of the course participant	integer	None.
FullName	Full name of the course participant	string	None.
PictureUrl	Avatar Url	string	None.
Status	EnrrollmentStatus	integer	None.
Mode	EnrrollmentMode	integer	None.
Email	Email	string	None.
IsExternal	Defines if the person is external.	boolean	None.
CourseId	The course's identifier.	integer	None.
IsMember	If true then the person is a member of the course.	boolean	None.
DefaultOrganisation	Default organisation for the person	string	None.
Role	Person role	string	None.
CustomerName	The name of the customer site the person belongs to.	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PersonId": 1,
    "FullName": "sample string 2",
    "PictureUrl": "sample string 3",
    "Status": 4,
    "Mode": 5,
    "Email": "sample string 6",
    "IsExternal": true,
    "CourseId": 8,
    "IsMember": true,
    "DefaultOrganisation": "sample string 10",
    "Role": "sample string 11",
    "CustomerName": "sample string 12"
  },
  {
    "PersonId": 1,
    "FullName": "sample string 2",
    "PictureUrl": "sample string 3",
    "Status": 4,
    "Mode": 5,
    "Email": "sample string 6",
    "IsExternal": true,
    "CourseId": 8,
    "IsMember": true,
    "DefaultOrganisation": "sample string 10",
    "Role": "sample string 11",
    "CustomerName": "sample string 12"
  }
]

application/xml, text/xml

Sample:

<ArrayOfCourseApplicant xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CourseApplicant>
    <CourseId>8</CourseId>
    <CustomerName>sample string 12</CustomerName>
    <DefaultOrganisation>sample string 10</DefaultOrganisation>
    <Email>sample string 6</Email>
    <FullName>sample string 2</FullName>
    <IsExternal>true</IsExternal>
    <IsMember>true</IsMember>
    <Mode>5</Mode>
    <PersonId>1</PersonId>
    <PictureUrl>sample string 3</PictureUrl>
    <Role>sample string 11</Role>
    <Status>4</Status>
  </CourseApplicant>
  <CourseApplicant>
    <CourseId>8</CourseId>
    <CustomerName>sample string 12</CustomerName>
    <DefaultOrganisation>sample string 10</DefaultOrganisation>
    <Email>sample string 6</Email>
    <FullName>sample string 2</FullName>
    <IsExternal>true</IsExternal>
    <IsMember>true</IsMember>
    <Mode>5</Mode>
    <PersonId>1</PersonId>
    <PictureUrl>sample string 3</PictureUrl>
    <Role>sample string 11</Role>
    <Status>4</Status>
  </CourseApplicant>
</ArrayOfCourseApplicant>