DELETE restapi/personal/courses/{courseId}/participants/v2
Removes one or more participants from the given courses
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
courseId |
The id of the course |
integer |
Required |
Body Parameters
The object holding the list of participants to be removed from the course
Itslearning.RestApi.Entities.CourseParticipants.CourseParticipantsToRemoveName | Description | Type | Additional information |
---|---|---|---|
ParticipantIdsToBeRemoved |
The ids of the participants to be removed from a course |
Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "ParticipantIdsToBeRemoved": [ 1, 2 ] }
application/xml, text/xml
Sample:
<CourseParticipantsToRemove xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <ParticipantIdsToBeRemoved xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:int>1</d2p1:int> <d2p1:int>2</d2p1:int> </ParticipantIdsToBeRemoved> </CourseParticipantsToRemove>
application/x-www-form-urlencoded
Sample:
No sample available
Response Information
Resource Description
System.Net.Http.HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | System.Version |
None. |
|
Content | System.Net.Http.HttpContent |
None. |
|
StatusCode | System.Net.HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | System.Net.Http.HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |