ListMeetingsRequest Element

Article
05/23/2014

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.

Represents a request sent to a conference center to list specific information about meetings that match supplied criteria.

Syntax

<ListMeetingsRequest
    listDeleted = "True" | "False"
    pageSize = "decimal"
    pageNum = "decimal">
</ListMeetingsRequest>

- Or -

<ListMeetingsRequest
    restorableOnly = "True" | "False">
    pageSize = "decimal"
    pageNum = "decimal">
</ListMeetingsRequest>

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

Attributes

Name	Description
listDeleted	Boolean type. Value range [True \| False]. If True, lists deleted meetings. If False, does not list deleted meetings.
pageNum	Decimal type. Specifies the page number of meeting list result pages to return. This is an optional attribute
pageSize	Decimal type. Specifies the number of meeting objects to return for each list page. This is an optional attribute.
restorableOnly	Boolean type. Value range [True \| False]. Possible states of a meeting: Active, Undeleted, Expired,Deleted, and Removed. For more information, see Remarks. If True, only expired and manually deleted meetings that can be restored are listed. If False, all meetings, including expired, deleted, and restored meetings, are listed. This attribute can only be specified by account administrators and cannot be specified with the listDeleted attribute. When restorableOnly is set to False, it returns all the removed, deleted, and active meetings in the same way as listDeleted when set to True. Added in Live Meeting service API Update for Live Meeting 2007.

Element Information

Parent Element

Element	Occurrence
PlaceWareConfCenter	1

Child Elements

Element	Occurrence
StringQuery	0 or 1
StringListQuery	0 or 1
TimeIntervalQuery	0 or 1
FieldList	1

Remarks

Definition of different meeting States

Active: All scheduled meetings that have not expired and are not deleted have this status.

Undeleted: All meetings restored after expiration or deletion have this status. These are as good as Active meetings.

Expired: All meetings that have expired (after reaching their expiration time) have this status.

Deleted: All manually deleted meetings have this status. If the conference center supports meeting restoration, these meetings can be restored by an administrator.

Removed: All meetings that are permanently deleted and can no longer be restored have this status.

For information about deleting and restoring meetings and recordings, see Maintaining Meetings and Recordings

The ListMeetingsRequest element must contain as its child element a StringQuery, StringListQuery, or TimeIntervalQuery element. When using the StringListQuery element, you are limited to a maximum of 100 string list items.

The StringQuery element can query for values of the following options:

billing
mid
name
opaque1
opaque2
owner
personalPlaceOf
title

The TimeIntervalQuery element can query for the following time options:

createOrModifyTime
endTime
startTime
visitedIn

The StringListQuery element can query for values of the following options:

mid
name
opaque1
opaque2
personalPlaceOf

The FieldList child element for ListMeetings can accept all the options available for CreateMeeting message and ModifyMeeting message. For a list of read/write and read-only options for FieldList element, see CreateMeetingRequest.

The pageSize and pageNum attributes are implemented in Live Meeting 2007 to allow for the pagination of meeting results. Pagination allows a caller to page through the large amounts of data that the API generates. For example, calling a ListMeetings message that uses the LIKE operator and "%" value generates every meeting for an entire account. When an API request generates a reply that exceeds an accounts API reply data threshold, the information returned is automatically paginated by returning the first page. The remaining information can then be requested on a page-by-page basis. Changing the pageNum attribute simply requests the specified page, if available, and an appropriate response if not. Changing the value of pageSize increases or decreases the number of meeting objects returned per page. Requesting a page number that is beyond the number of actual pages of data returns the last page. If all the data fits on one page, the returned data is not paginated.

Example

The following code shows the request format.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <ListMeetingsRequest restorableOnly="True" pageSize="5" pageNum="1">
     <StringQuery fieldName="name"
                    operator="LIKE"
                    value="MySeriesMeeting%"
                     tag="LRS"/>
     <FieldList>
        <Name>name</Name>
        <Name>mid</Name>
        <Name>startTime</Name>
     </FieldList>
  </ListMeetingsRequest>
</PlaceWareConfCenter>

The reply to the previous request looks like the following code snippet.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PlaceWareConfCenter>
   <ListMeetingsReply>
      <MeetingReply>
         <OptionList>
            <StringOption value="MySeriesMeeting1" name="name">
            </StringOption>
            <TimeOption value="2007-06-29T20:00:00Z" name="startTime">
            </TimeOption>
         </OptionList>
      </MeetingReply>
      <MeetingReply>
         <OptionList>
            <StringOption value="MySeriesMeeting2" name="name">
            </StringOption>
            <TimeOption value="2007-07-18T20:00:00Z" name="startTime">
            </TimeOption>
         </OptionList>
      </MeetingReply>
      <MeetingReply>
         <OptionList>
            <StringOption value="MySeriesMeeting3" name="name">
            </StringOption>
            <TimeOption value="2007-08-05T20:00:00Z" name="startTime">
            </TimeOption>
         </OptionList>
      </MeetingReply>
      <MeetingReply>
         <OptionList>
            <StringOption value="MySeriesMeeting4" name="name">
            </StringOption>
            <TimeOption value="2007-09-25T20:00:00Z" name="startTime">
            </TimeOption>
         </OptionList>
      </MeetingReply>
      <MeetingReply>
         <OptionList>
            <StringOption value="MySeriesMeeting5" name="name">
            </StringOption>
            <TimeOption value="2007-10-29T20:00:00Z" name="startTime">
            </TimeOption>
         </OptionList>
      </MeetingReply>
      <InfoWarnFaultList>
         <InfoWarn>
            <Code>Server.MoreData.OtherPagesExist</Code>
            <Message>This query returned a partial result set. There are 3 pages of data available.  This is page 1.</Message>
            <OptionList>
               <DecimalOption value="3" name="pageCount">
               </DecimalOption>
               <DecimalOption value="1" name="pageNum">
               </DecimalOption>
               <TimeOption value="2007-06-29T21:01:15Z" name="time">
               </TimeOption>
               <StringOption value="r33cn59c0v" name="rapid.requestId">
               </StringOption>
            </OptionList>
         </InfoWarn>
      </InfoWarnFaultList>
   </ListMeetingsReply>
</PlaceWareConfCenter>

For more information about the response format, see MeetingReply.