Fault 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 an error message returned from a conference center when a request cannot be processed successfully.

Syntax

<Fault>
    ...
</Fault>

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

Attributes

None.

Element Information

Parent Element

Element	Occurrence
PlaceWareConfCenter	1

Child Elements

Element	Occurrence
FaultCode	1
FaultString	1
OptionList	1

Remarks

FaultCode is not an empty element and contains a fault code string with the length in the range of 1-2047 characters. For more information, see FaultCode element.

FaultString contains a non-localized text string for the purpose of debugging. For more information, see FaultString element.

The OptionList child element can contain options that depend on the fault code. These options are specified along with the corresponding fault codes. Options can correspond to any level of the fault code hierarchy or to all levels. All options are optional; API client software must not depend on the presence of any option. All options specified in the following table correspond to the most general level of the fault code hierarchy.

Top Level Fault Options

Option Name	Description
TimeOption	Specifies the time when the error is detected. There is always one TimeOption child element of the OptionList and zero or more other options depending on the error.

TimeOption

Specifies the time when the error is detected.

There is always one TimeOption child element of the OptionList and zero or more other options depending on the error.

The following table lists the fault conditions and fault messages returned by a conference center for DeleteMeeting, DeleteRecording, RestoreMeeting, and RestoreRecording requests.

API	Current Entity State	Requested Final State	Fault Message
DeleteMeeting	Deleted	Deleted	The meeting you are trying to delete is already in the Deleted state. It should be in the Active or Undeleted state.
DeleteMeeting	Expired	Deleted	The meeting you are trying to delete is already in the Expired state. It should be in the Active or Undeleted state.
DeleteMeeting with erase=True	Active	Removed	The meeting you are trying to permanently delete is in the Active state. It should be in the Deleted or Expired state.
DeleteMeeting with erase=True	Undeleted	Removed	The meeting you are trying to permanently delete is in the Undeleted state. It should be in the Deleted or Expired state.
RestoreMeeting	Active	Undeleted	The meeting you are trying to restore is already in the Active state. It should be in the Deleted or Expired state.
RestoreMeeting	Undeleted	Undeleted	The meeting you are trying to restore is already in the Undeleted state. It should be in the Deleted or Expired state.
DeleteRecording	Deleted	Deleted	The recording you are trying to delete is already in the Deleted state. It should be in the Active or Undeleted state.
DeleteRecording	Expired	Deleted	The recording you are trying to delete is already in the Expired state. It should be in the Active or Undeleted state.
DeleteRecording with erase="True	Active	Removed	The recording you are trying to permanently delete is in the Active state. It should be in the Deleted or Expired state.
DeleteRecording with erase=True	Undeleted	Removed	The recording you are trying to permanently delete is in the Undeleted state. It should be in the Deleted or Expired state.
RestoreRecording	Active	Undeleted	The recording you are trying to restore is already in the Active state. It should be in the Deleted or Expired state.
RestoreRecording	Undeleted	Undeleted	The recording you are trying to restore is already in the Undeleted state. It should be in the Deleted or Expired state.

Example

The following examples show that when a faulty message is sent to a conference center, an error message is returned.

The following is a request sent to a conference center to schedule a meeting for the Scandinavian market. Unfortunately, an illegal character is used in the name attribute in CreateMeetingRequest. This triggers a Fault element returned.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <CreateMeetingRequest
      maxUsers="4"
      name="mte"
      startTime="2000-07-31T09:00:00Z"
      title="Contoso 2001 Scandinavian Strategy">
    <OptionList>
      <TimeOption name="endTime" value="2000-07-31T10:00:00Z"/>
      <StringOption name="timeZone" value=" America/Los_Angeles"/>
    </OptionList>
    <FieldList>
      <Name>mid</Name>
      <Name>audiencePassword</Name>
      <Name>presenterPassword</Name>
    </FieldList>
  </CreateMeetingRequest>
</PlaceWareConfCenter>

The following is the reply returned from the conference center showing an error occurred while processing the request.

<PlaceWareConfCenter>
    <Fault>
        <FaultCode>Client.BadSyntax.BadCharacter.String</FaultCode>
        <FaultString>Value must not contain ''</FaultString>
        <OptionList>
            <StringOption value="name" name="fieldName">
            </StringOption>
            <StringOption value="mte" name="stringValue">
            </StringOption>
            <TimeOption value="2007-09-25T21:23:51Z" name="time">
            </TimeOption>
            <StringOption value="q11fgq5znm" name="rapid.requestId">
            </StringOption>
        </OptionList>
    </Fault>
</PlaceWareConfCenter>

The error occurred because the name attributeof the CreateMeetingRequest cannot contain any letters except a-z and A-Z. Characters outside this range are not permitted.

Share via