Scheduling a Meeting

  • 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.

Creating a meeting using the Live Meeting service API amounts to declaring your meeting specifications in a CreateMeetingRequest Element element and posting the XML element to a conference center using the posting URL. The following meeting request declares that a one-time meeting is scheduled between 14:00:00 UTC and 18:00:00 UTC on October 27, 2007. A maximum number of 100 participants can attend the meeting. Note that the specifications are listed using the OptionList Element element. The allowed options for creating a meeting are documented in the CreateMeetingRequest Element element.

The following code example schedules a OneTime meeting with a maximum attendance of 100 individuals.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
<CreateMeetingRequest
       maxUsers="100"
       name="ShipParty"
       title="Come to celebrate">
  <OptionList>
    <TimeOption name="startTime" value="2007-10-27T14:00:00Z"/>
    <TimeOption name="endTime" value="2007-10-27T18:00:00Z"/>
    <StringOption name="timeZone" value="America/Los_Angeles"/>
    <EnumerationOption name="meetingType" value="OneTime" >
      <String>OneTime</String>
      <String>MeetNow</String>
      <String>Recurring</String>
    </EnumerationOption>
  </OptionList>
  <FieldList>
    <Name>name</Name>
    <Name>meetingType</Name>
    <Name>mid</Name>
    <Name>presenterPassword</Name>
    <Name>audiencePassword</Name>
  </FieldList>
</CreateMeetingRequest>
</PlaceWareConfCenter>

The FieldList Element element in the CreateMeetingRequest element is used to specify the meeting attributes that should be listed in the reply. In this example, the meeting ID (name), the mid, and the meeting type (meetingType) are solicited from the conference center. In addition, passwords for the presenter and audience are listed.

In any XxxRequest element, the OptionList Elementis used to hold the input parameter for a message and the FieldList Element element is used to hold the output parameter of the call.

When the request is processed successfully, the conference center replies with the following CreateMeetingReply Element element.

Example 1

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PlaceWareConfCenter>
   <CreateMeetingReply>
      <MeetingReply><OptionList>
         <StringOption value="ShipParty" name="name"></StringOption>
         <EnumerationOption value="OneTime" name="meetingType">
            <String>OneTime</String>
            <String>MeetNow</String>
            <String>Recurring</String>
         </EnumerationOption>
         <StringOption value="jg2362b8n9rhl6gs" name="mid" />
         <StringOption value="T&lt;@Cc5r{X" name="presenterPassword" />
         <StringOption value="CM{r+9T}G" name="audiencePassword" />
      </OptionList></MeetingReply>
   </CreateMeetingReply>
</PlaceWareConfCenter>

Example 2

The meeting is scheduled on an on-going or recurring basis. To schedule such a meeting, the application first specifies the date range of the recurrence. In this case, the range is January 28, 2007, to February 25, 2007. Next, it specifies the meeting start and end times, followed by the pattern of recurrence. The date portion of the recurrenceRangeStart value specifies the starting date of the recurrence range while the date portion of the recurrenceRangeEnd value specifies the last day of the range. The recurrencePatternDaily value specifies that the meeting should occur every four days between January 28 and continuing through April 28. StartTime and EndTime specify the start and end time of each meeting occurrence, in this case 1:00PM -2:00PM in PST.  Time values are specified in UTC and the Live Meeting service will do a time zone conversion to determine the correct local time for meetings.  These conversions can be difficult, particularly when recurrence spans daylight savings time boundaries, therefore the best practice is to calculate the date and time of the start of the first meeting occurrence and use that value for both recurrenceRageStart and StartTime, and calculate the date and time of the end of the last meeting occurrence and use that for recurrenceRangeEnd and EndTime.

If both of the recurrence patterns are supplied, the recurrencePatternDaily has priority.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<PlaceWareConfCenter authUser="admin" authPassword="admin">
   <CreateMeetingRequest title="ship party" maxUsers="5">
      <OptionList>
         <EnumerationOption value="Recurring" name="meetingType">
            <String>OneTime</String>
            <String>MeetNow</String>
            <String>Recurring</String>
         </EnumerationOption>
         <StringOption value="T&lt;@Cc5r{X" name="presenterPassword" />
         <StringOption value="CM{r+9T}G" name="audiencePassword" />
         <TimeOption name="recurrenceRangeStart" value="2008-01-28T21:00:00Z" />
         <TimeOption name="recurrenceRangeEnd" value="2008-02-25T22:00:00Z" />
         <TimeOption name="startTime" value="2008-01-28T21:00:00Z" />
         <TimeOption name="endTime" value="2008-02-25T22:00:00Z" />
         <StringOption name="timeZone" value="America/Los_Angeles" />
         <DecimalOption name="recurrencePatternDaily" value="4" />
      </OptionList>
  <FieldList>
    <Name>name</Name>
    <Name>meetingType</Name>
    <Name>mid</Name>
    <Name>presenterPassword</Name>
    <Name>audiencePassword</Name>
  </FieldList>
   </CreateMeetingRequest>
</PlaceWareConfCenter>

If the meeting is to be scheduled on multiple days in a given week, the recurrencePatternWeeky option must be used. For example, if the meeting is to occur on Monday, Tuesday, and Thursday, the value of the option is as follows.

<StringOption name="recurrencePatternWeekly value="-ss-s--"</StringOption>

See Also

Concepts

Using the Live Meeting service API