DeleteMeetingRequest Element

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Removes a meeting by sending a request to a conference center.

Syntax

<DeleteMeetingRequest erase = "True" | "False">
</DeleteMeetingRequest>

The following sections describe attributes, parent elements, and child elements.

Attributes

Name

Description

erase

Boolean attribute. Value range [True | False]. This attribute is optional.

If True, the meeting is deleted permanently. A True value can be specified only for already expired or manually deleted meetings, but not for an active or restored meeting. A False value can be specified only for an active or restored meeting, but not for already expired or manually deleted meetings.

If False and restoration is set to ON for the account by the Administrator, the meeting is deleted but can be restored within the buffer time. However, if False and restoration is set to OFF for the account by the Administrator, the meeting is permanently deleted. Only the account administrator can set the restoration in Live Meeting Manager (point to Administer, point to Roles and Policies, point to Edit Meeting Policies, and then click Restoration).

NoteNote
This attribute can only be set by account administrators. If this attribute is absent, it is treated as a False value for this attribute.
Important noteImportant
Deleted meetings, similar to meetings that are permanently deleted (removed), do not count towards the schedule limit for the account. However, deleted meetings that are restored do count towards this limit.

Added in Live Meeting service API Update for Live Meeting 2007.

Element Information

Parent Element

Element

Occurrence

PlaceWareConfCenter

1

Child Element

Element

Occurrence

StringQuery

0 or 1

StringListQuery

0 or 1

Remarks

The DeleteMeetingRequest element must include either the StringQuery or StringListQuery element. The request cannot include both child elements. A Fault element is returned if both elements are specified.

The StringQuery must match exactly one non-deleted meeting. The StringQuery and the StringListQuery elements can search the following options:

  • mid

  • personalPlaceOf

  • name

  • opaque1

  • opaque2

The StringListQuery element can be used to bulk delete more than one meeting. It passes up to 100 option items, resulting in a maximum of 100 meetings deleted.

Note

If there are no meetings matching the identifiers in this element, no exceptions are thrown.

Deleting a meeting removes it from the schedule and unpublished recordings are deleted. The documents and published recordings of the meeting are not deleted. You can retrieve information about deleted meetings using ListMeetingsRequest.

When using StringQuery and attempting to delete a meeting, a DeleteMeetingReply element is returned on success and a Fault element is returned on failure. When a DeleteMeeting is successfully called using the personalPlaceOf option, the meeting is automatically removed permanently and cannot be restored. For a complete list of fault return values, see Fault Element. For more information about deleting a meeting or recording, see Maintaining Meetings and Recordings.

Examples

The following code shows a series of requests to erase meetings sent to the conference center.

Example 1

This example illustrates a successful request to erase two meetings on the conference center.

Request

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <DeleteMeetingRequest erase="true">
    <StringListQuery fieldName="mid">
      <String>jnbzqqkh63ms1tgv</String>
      <String>prbzqqkh93ms1tgv</String>
    </StringListQuery>
  </DeleteMeetingRequest>
</PlaceWareConfCenter>

Reply

<PlaceWareConfCenter>
  <DeleteMeetingReply>
  </DeleteMeetingReply>
</PlaceWareConfCenter>

Example 2

The following example shows a request to erase a meeting that is already erased.

Request

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
   <DeleteMeetingRequest>
      <StringQuery fieldName="name" operator="=" value="deletedMtg01"/>
   </DeleteMeetingRequest>
</PlaceWareConfCenter>

Reply

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadState.Meeting</FaultCode>
      <FaultString>The meeting you are trying to delete is already in Deleted state. It should be in either Active or Undeleted state.</FaultString>
      <OptionList>
         <TimeOption value="2007-07-11T22:48:35Z" name="time">
         </TimeOption>
         <StringOption value="sd5j2g7h6r" name="rapid.requestId">
         </StringOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Example 3

This example illustrates an attempt to delete an expired meeting.

Request

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
   <DeleteMeetingRequest>
      <StringQuery fieldName="name" operator="=" value="expiredMtg01" />
   </DeleteMeetingRequest>
</PlaceWareConfCenter>

Reply

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadState.Meeting</FaultCode>
      <FaultString>The meeting you are trying to delete is already in Expired state. It should be in either Active or Undeleted state.</FaultString>
      <OptionList>
         <TimeOption value="2007-07-11T22:38:43Z" name="time">
         </TimeOption>
         <StringOption value="cv4t6c30jl" name="rapid.requestId">
         </StringOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Example 4

This example illustrates an attempt to permanently delete an active meeting, setting erase equal to true.

Request

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
   <DeleteMeetingRequest erase="true">
      <StringQuery fieldName="name" operator="=" value="activeMtg01" />
   </DeleteMeetingRequest>
</PlaceWareConfCenter>

Reply

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadState.Meeting</FaultCode>
      <FaultString>The meeting you are trying to permanently delete is in Active state. It should be in either Deleted or Expired state.</FaultString>
      <OptionList>
         <TimeOption value="2007-07-11T22:49:55Z" name="time">
         </TimeOption>
         <StringOption value="sglgf09mhg" name="rapid.requestId">
         </StringOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Example 5

This example illustrates an attempt to delete an undeleted meeting.

Request

<PlaceWareConfCenter authUser="BVTAdmin" authPassword="Pa$$w0rd">
   <DeleteMeetingRequest erase="true">
      <StringQuery fieldName="name" operator="=" value="undeletedMtg01" />
   </DeleteMeetingRequest>
</PlaceWareConfCenter>

Reply

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadState.Meeting</FaultCode>
      <FaultString>The meeting you are trying to permanently delete is in Undeleted state. It should be in either Deleted or Expired state.</FaultString>
      <OptionList>
         <TimeOption value="2007-07-11T22:50:04Z" name="time">
         </TimeOption>
         <StringOption value="qnbr4tvmbl" name="rapid.requestId">
         </StringOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

See Also

Concepts

DeleteMeetingReply Element

DeleteMeeting Message

ListMeetingsRequest Element