Fault Messages

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.

Each request generates either a successful reply or an error. An error is represented by a Fault element. The following table specifies the child elements of Fault. The child elements must be in the order shown in the table.

Fault Child Elements

The FaultCode element contains one non-empty fault code string with length in the range of 1 through 2047 characters. A fault code string denotes an error in a hierarchy of errors that proceeds from the general to the specific. The character "." (dot) separates the levels in the hierarchy. The part to the left of each dot is more general; the part to the right is more specific.

This section specifies a fault code hierarchy. API client software must accept any fault code string, whether or not it is mentioned in this specification. Any specific conference center release may not return all the fault codes specified in this section.

The FaultString element contains one string with length in the range of 1 through 2047 characters. It contains non-localized text intended for use in debugging.

The OptionList may contain options that depend on the fault code. These options are specified along with the corresponding fault codes. Options may 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

Here is an example of some XML code with an error and the corresponding Fault. You want to schedule a meeting for the Scandinavian market. You send the following request to the conference center.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <CreateMeetingRequest
      maxUsers="4"
      name="mte"
      startTime="2006-07-31T09:00:00Z"
      title="Tailspin Toys 2006 Scandinavian Strategy">
    <OptionList>
      <TimeOption name="endTime" value="2006-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 conference center returns the following reply.

<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 CreateMeetingRequestname attribute cannot contain any letters except a through z and A through Z. Characters outside this range are not permitted.

The following sections specify the fault code hierarchy and associated options, beginning with an overview of the top two levels in the hierarchy.

In This Section

See Also

Concepts

Error and Status Messages