Options and Expected Return Values
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.
A message request can have input parameters. They are used to control how an operation should be performed. For example, to schedule a one-hour meeting on Monday, you need to supply the start time and end time in your message request. In the Live Meeting service API, such input parameters can be contained in an OptionList element under the root element of a message request. An OptionList element contains a list of typed options. Each option specifies the name and value of an input parameter. For example, the following option list can be used in a CreateMeetingRequest element to specify the start and end time of the meeting.
<OptionList>
<TimeOption name="startTime" value="2007-04-01T18:00:00Z"/>
<TimeOption name="endTime" value="2007-04-01T20:00:00Z"/>
<StringOption name="timeZone" value="America/Los_Angeles"/>
</OptionList>
Options are message-specific. For information about what options can be used for a message request, see Live Meeting service API Reference.
Unrecognized options result in the return of a fault code. In the previous example, if the following code:
<StringOption name="frozzle" value="glurrrrp"/>
is included, the following fault code is returned from the conference center in a reply message.
<FaultCode>Client.BadSyntax.NotAllowed.Field</FaultCode>
Likewise, a request message can specify that values of certain options be returned in a response from a conference center when the request is successfully fulfilled. For example, in a query to find all scheduled meetings, you might want to specify the subject, time, or owner of the meeting to be returned to you. In the Live Meeting service API, such desired return values are contained in a FieldList child element under the root element of a message request. For example, the following FieldList element in a ListMeetingsRequest element specifies some option values to be returned in a response.
<FieldList>
<Name>mid</Name>
<Name>title</Name>
<Name>owner</Name>
<Name>presenterList</Name>
<Name>startTime</Name>
<Name>endTime</Name>
<Name>timeZone</Name>
<Name>recordingEnabled</Name>
/FieldList>
Unknown or unset options declared in a FieldList element are ignored in the message reply.
In a message reply, the specified return parameters (as declared in FieldList above) are returned in an OptionList element under the corresponding message reply element. In the example above, the message reply is ListMeetingsReply. The following example shows the returned values according to the specification in the FieldList element.
<MeetingReply>
<OptionList>
<StringOption value="776j070m1566lrz9" name="mid"></StringOption>
<StringOption value="My Meeting" name="title"></StringOption>
<StringOption value="Leader" name="owner"></StringOption>
<TimeOption value="2007-10-28T19:30:00Z" name="startTime"></TimeOption>
<TimeOption value="2007-10-28T20:30:00Z" name="endTime"></TimeOption>
<StringOption value="America/Los_Angeles" name="timeZone"></StringOption>
<BooleanOption value="True" name="recordingEnabled"></BooleanOption>
</OptionList>
</MeetingReply>
For more information about what options are available in a given message and whether return values can be specified in a message request, see Live Meeting service API Reference.
When a reply message contains an unknown option, such as shown in the following example, the client application should ignore such an option.
<StringOption name="frozzle" value="glurrrrp"/>