POST restapi/personal/courses/{courseId}/addparticipants/v1

Add persons to add to a course.

The user needs access to add persons to a course. The user can not add persons with higher profiles than the user itself.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
courseId

The course identifier.

integer

Required

Body Parameters

Object with personId and profileId

Collection of Itslearning.RestApi.Entities.CourseParticipantToAdd
NameDescriptionTypeAdditional information
PersonId

Gets or sets the person identifier.

integer

None.

CourseProfileId

Gets or sets the course profile identifier for the user.

integer

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "PersonId": 1,
    "CourseProfileId": 2
  },
  {
    "PersonId": 1,
    "CourseProfileId": 2
  }
]

application/xml, text/xml

Sample:
<ArrayOfCourseParticipantToAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CourseParticipantToAdd>
    <CourseProfileId>2</CourseProfileId>
    <PersonId>1</PersonId>
  </CourseParticipantToAdd>
  <CourseParticipantToAdd>
    <CourseProfileId>2</CourseProfileId>
    <PersonId>1</PersonId>
  </CourseParticipantToAdd>
</ArrayOfCourseParticipantToAdd>

application/x-www-form-urlencoded

Sample:
No sample available

Response Information

Resource Description

A list of persons that can be added to the course. Will not contain users already added

None.