34 lines
1.0 KiB
Plaintext
34 lines
1.0 KiB
Plaintext
--
|
|
:api: delete-calendar
|
|
:request: DeleteCalendarRequest
|
|
:response: AcknowledgedResponse
|
|
--
|
|
[id="{upid}-{api}"]
|
|
=== Delete Calendar API
|
|
Delete a {ml} calendar.
|
|
The API accepts a +{request}+ and responds
|
|
with a +{response}+ object.
|
|
|
|
[id="{upid}-{api}-request"]
|
|
==== Delete Calendar Request
|
|
|
|
A `DeleteCalendar` object requires a non-null `calendarId`.
|
|
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
---------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-request]
|
|
---------------------------------------------------
|
|
<1> Constructing a new request referencing an existing Calendar
|
|
|
|
[id="{upid}-{api}-response"]
|
|
==== Delete Calendar Response
|
|
|
|
The returned +{response}+ object indicates the acknowledgement of the request:
|
|
["source","java",subs="attributes,callouts,macros"]
|
|
---------------------------------------------------
|
|
include-tagged::{doc-tests-file}[{api}-response]
|
|
---------------------------------------------------
|
|
<1> `isAcknowledged` was the deletion request acknowledged or not
|
|
|
|
include::../execution.asciidoc[]
|