DELETE api/PersonEvent/Delete?eventId={eventId}&reason={reason}&deleteRecurring={deleteRecurring}&isNoShow={isNoShow}
As a student attendee of the specified future event, delete the event (removes oneself as an attendee). If deleting all recurring events, set deleteRecurring as true. Non-empty reason is required - Availability: Deletes availability - Study Session: Since StudySesison is 1:1, removing oneself from attendee list cancels the event. - Group Session: Removes oneself as attendee - aka "unsubscribe" or "unenroll" from group session. This does not cancel the event. - Other resources: Not supported
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
eventId |
Event ID to delete. If deleteRecurring, first eventId in the deleting series |
integer |
Required |
reason |
Reason for deleting the event(s) |
string |
Required |
deleteRecurring |
Whether to delete future recurring events |
boolean |
Required |
isNoShow |
optional param for no shows |
integer |
Default value is -1 |
Body Parameters
None.
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |