FaultCode Element

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

Contains a non-empty fault code string. The length of the string is in the range of 1-2047 characters.

Syntax

<FaultCode>...</FaultCode>

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

Attributes

None.

Element Information

Parent Element

Element

Occurrence

Fault

1

Child Element

Element

Occurrence

None

Not applicable

Remarks

FaultCode is not an empty element and contains a fault code string with length in the range of 1-2047 characters. The options in the OptionList of a Fault element are fault code dependent. For example, the Fault containing the Client.BadSyntax.BadCharacter.String FaultCode also contains information about what and where the bad character is located.

   <Fault>
      <FaultCode>Client.BadSyntax.BadCharacter.String</FaultCode>
      <FaultString>name must not contain &apos;&apos;</FaultString>
      <OptionList>
         <TimeOption name="time" value="2000-05-31T20:53:47Z"/>
         <StringOption name="fieldName" value="name"/>
         <StringOption name="badCharacter" value=""/>
         <StringOption name="stringValue" value="mte"/>
      </OptionList>
   </Fault>

Client software must accept any fault code string, regardless of whether it is mentioned in this specification. Any specific conference center release might not return all the fault codes specified in this section.

Example

The example shows a CreateGroupRequest attempting to create a new group that contains some nonexistent users.

The user has made a request to create a new group containing an existing group called MoreUsers.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
   <CreateGroupRequest
       groupID = "string">
      <UserList>
         <U>Michael</U>
         <U>Susan</U>
      </UserList>
   </CreateGroupRequest>
</PlaceWareConfCenter>

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadData.NoSuch.UserOrGroup.User</FaultCode>
      <FaultString>Unknown users.</FaultString>
      <OptionList>
         <TimeOption name="time" value="2001-05-31T20:53:47Z"/>
         <StringOption name="fieldName" value="UserList"/>
         <StringListOption name="ids">
            <String>Michael</String>
            <String>Susan</String>
         </StringListOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

See Also

Concepts

Fault Messages