Share via

Client.BadSyntax Fault Messages

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

A field (option, attribute, element, or part of a URL) violated some syntactic constraint of this specification. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax Fault Options

Name

Description

fieldName

StringOption. Length value 1-255 characters.

Specifies the name of the field that violated the constraint.

Client.BadSyntax.BadCharacter

A character is not allowed in the value of a field. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.BadCharacter Fault Options

Name

Description

badCharacter

StringOption.

Specifies the invalid character.

Client.BadSyntax.BadCharacter.ItemInList

A character is not allowed in an item in a list. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.BadCharacter.ItemInList Fault Options

Name

Description

index

decimalOption. Value range 0 to 231-1.

Specifies the index of the item that contains the invalid character. The first item in the list has index zero.

Client.BadSyntax.BadCharacter.ItemInList.String

A character is not allowed in a string in a list. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.BadCharacter.ItemInList.String Fault Options

Name

Description

stringValue

StringOption.

Specifies the value of the string containing the invalid character.

Client.BadSyntax.BadCharacter.String

A character is not allowed in a string. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.BadCharacter.String Fault Options

Name

Description

stringValue

StringOption.

Specifies the value of the string containing the invalid character.

Client.BadSyntax.BadChoice

A choice is invalid. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.BadChoice Fault Options

Name

Description

badChoice

StringOption.

Specifies the invalid choice.

choices

StringListOption.

Specifies the valid choices available.

Client.BadSyntax.BadChoice.ApplicationSharing

An application sharing choice is not one of the choices specified in section OptionList.

Client.BadSyntax.BadChoice.AudioBroadcast

Occurs when enableAudioBroadcast is specified as true, and enableAudioVOIP is specified as false. enableAudioBroadcast can only be true, when enableAudioVOIP is also true, or it is not specified in the request.

Client.BadSyntax.BadChoice.Enumeration

An enumeration choice is not one of the choices in the enumeration.

The example shows an attempt to use blackAndWhite as part of the choices in applicationSharingColor.

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadSyntax.BadChoice.Enumeration</FaultCode>
      <FaultString>Invalid enumeration option value.</FaultString>
      <OptionList>
         <TimeOption name="time" value="2002-05-31T00:53:47Z"/>
         <StringOption name="fieldName" value="applicationSharingColor"/>
         <StringOption name="badChoice" value="blackAndWhite"/>
         <StringListOption name="choices">
            <String>16bitColor</String>
            <String>24bitColor</String>
            <String>256Color</String>
            <String>16shadeGray</String>
            <String>256shadeGray</String>
         </StringListOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Client.BadSyntax.BadChoice.Field

The field name in a query is invalid.

The example from a ModifyMeetingRequest shows an attempt to select the meeting with a StringQuery on the billing field.

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadSyntax.BadChoice.Field</FaultCode>
      <FaultString>Invalid field.</FaultString>
      <OptionList>
         <TimeOption name="time" value="2002-06-31T01:53:47Z"/>
         <StringOption name="fieldName" value="fieldName"/>
         <StringOption name="badChoice" value="billing"/>
         <StringListOption name="choices">
            <String>mid</String>
            <String>name</String>
            <String>opaque1</String>
            <String>opaque2</String>
            <String>personalPlaceOf</String>
         </StringListOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Client.BadSyntax.BadChoice.Operator

The operator in a query is invalid.

The example from a ListMeetingsRequest shows an attempt to use a StringQuery with a not-equals operator.

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadSyntax.BadChoice.Operator</FaultCode>
      <FaultString>Invalid operator.</FaultString>
      <OptionList>
         <TimeOption name="time" value="2002-04-31T02:53:47Z"/>
         <StringOption name="fieldName" value="operator"/>
         <StringOption name="badChoice" value="!="/>
         <StringListOption name="choices">
            <String>=</String>
            <String>LIKE</String>
         </StringListOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Client.BadSyntax.BadChoice.Printing

A printing choice is not one of the choices specified.

Client.BadSyntax.BadChoice.RecordingFormat

A recording format choice is invalid.

Client.BadSyntax.BadChoice.SeatColor

A seat color choice is invalid.

Client.BadSyntax.BadFormat

The data in a field are not in a valid format.

Client.BadSyntax.BadFormat.EmailAddress

A field does not contain a valid e-mail address.

Client.BadSyntax.BadFormat.FilePath

A field does not contain a valid file path.

Client.BadSyntax.BadFormat.FilePath.Absolute

A field contains an absolute file path, but a relative path is required.

Client.BadSyntax.BadFormat.FilePath.UsesParent

A field contains a file path that references, somewhere in the path, a parent directory.

Client.BadSyntax.BadFormat.GroupID

A field does not contain a valid group ID.

Client.BadSyntax.BadFormat.ID

A field does not contain a valid mid or reid

Client.BadSyntax.BadFormat.HTTPBody

The body of an HTTP or HTTPS request is not in the required format.

Client.BadSyntax.BadFormat.HTTPBody.NotBase64

The body of an HTTP or HTTPS request is not in base-64 format when this is required.

Client.BadSyntax.BadFormat.MeetingOrRecordingName

A field does not contain a valid meeting or recording name.

Client.BadSyntax.BadFormat.SlidesTxt

A slides.txt entry in a slide set is invalid.

Client.BadSyntax.BadFormat.UserID

A field does not contain a valid user ID.

Client.BadSyntax.BadType

The type of a field is not the type required.

Client.BadSyntax.BadType.BadQuery

A type of query is used in a request where it is not allowed.

Client.BadSyntax.BadType.BadQuery.TimeInterval

A TimeInterval query is used in a request where it is not allowed.

Client.BadSyntax.BadType.NeedApplicationSharing

The type of a field is not application sharing, which is the type required.

Client.BadSyntax.BadType.NeedBoolean

The type of a field is not boolean, which is the type required.

Client.BadSyntax.BadType.NeedDecimal

The type of a field is not decimal, which is the type required.

Client.BadSyntax.BadType.NeedEnumeration

The type of a field is not enumeration, which is the type required.

Client.BadSyntax.BadType.NeedEnumerationChoices

The type of a field is enumeration as required, but the enumeration does not contain the required choices in the required order. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.BadType.NeedEnumerationChoices Fault Options

Name

Description

choices

StringListOption.

Specifies the required enumeration choices in the required order.

The example uses ModifyMeeting in an attempt to change the initial seat color in a request.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <ModifyMeetingRequest newMid="False">
    <StringQuery fieldName="mid" operator="=" value="k77balgqvew2"/>
    <OptionList>
      <EnumerationOption name="initialSeatColor" value="red">
        <String>red</String>
        <String>blue</String>
        <String>yellow</String>
        <String>teal</String>
        <String>purple</String>
      </EnumerationOption>
    </OptionList>
    <FieldList>
      <Name>mid</Name>
    </FieldList>
  </ModifyMeetingRequest>
</PlaceWareConfCenter>

Although red is a valid choice for the initial seat color, the enumeration type (red, blue, yellow, teal, purple) is not the required type (red, blue, yellow, green, purple). The conference center returns the following reply.

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadSyntax.BadType.NeedEnumerationChoices</FaultCode>
      <FaultString>Invalid enumeration option type.</FaultString>
      <OptionList>
         <TimeOption name="time" value="2002-02-31T03:53:47Z"/>
         <StringOption name="fieldName" value="initialSeatColor"/>
         <StringListOption name="choices">
            <String>red</String>
            <String>blue</String>
            <String>yellow</String>
            <String>green</String>
            <String>purple</String>
         </StringListOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Client.BadSyntax.BadType.NeedLocale

The type of a field is not locale, which is the type required.

Client.BadSyntax.BadType.NeedLocaleList

The type of a field is not locale list, which is the type required.

Client.BadSyntax.BadType.NeedPrinting

The type of a field is not printing, which is the type required.

Client.BadSyntax.BadType.NeedString

The type of a field is not string, which is the type required.

Client.BadSyntax.BadType.NeedStringList

The type of a field is not stringList, which is the type required.

Client.BadSyntax.BadType.NeedTime

The type of a field is not time, which is the type required.

Client.BadSyntax.BadType.NeedTimeInterval

The type of a field is not timeInterval, which is the type required.

Client.BadSyntax.BadType.NeedTimeIntervalList

The type of a field is not timeIntervalList, which is the type required.

Client.BadSyntax.CannotRemove

A field that cannot be removed appears in a RemoveList

Client.BadSyntax.Duplicate

A field incorrectly appears in two or more contexts. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.Duplicate Fault Options

Name

Description

contexts

StringListOption.

Specifies the contexts in which the field appears.

The example from a ModifyMeetingRequest shows that the infoA option was in both its OptionList and its RemoveList.

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadSyntax.Duplicate</FaultCode>
      <FaultString>Duplicate option.</FaultString>
      <OptionList>
         <TimeOption name="time" value="2002-01-31T04:53:47Z"/>
         <StringOption name="fieldName" value="infoA"/>
         <StringListOption name="contexts">
            <String>OptionList</String>
            <String>RemoveList</String>
         </StringListOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Client.BadSyntax.Duplicate.Option

A field in an option list incorrectly appears in two or more contexts.

Client.BadSyntax.Duplicate.Option.Name

Two or more options with the same option name appear in one option list.

Client.BadSyntax.Empty

A value is empty when this is not allowed.

Client.BadSyntax.Empty.Enumeration

An enumeration contains no choices.

Client.BadSyntax.Empty.Group

A group has no members.

Client.BadSyntax.Empty.List

A list has no members. For example, a field list has no field names.

Client.BadSyntax.Empty.SlideSet

A slide set has no valid slides.

Client.BadSyntax.Empty.TimeInterval

The end time of a time interval is not after the start time. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.Empty.TimeInterval Fault Options

Name

Description

startTime

TimeOption.

Specifies the start time.

endTime

TimeOption.

Specifies the end time.

Client.BadSyntax.Missing

A required field is missing.

Client.BadSyntax.Missing.Auth

One or more authorization attributes are missing. Specifically, authTicket is not present or blank and authUser and or authPassword are missing.

Client.BadSyntax.Missing.Need1

All fields in a set of fields are missing when exactly one is required to be present. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.Missing.Need1 Fault Options

Name

Description

fieldNames

StringListOption.

Specifies the set of fields.

Client.BadSyntax.Missing.NeedAll

At least one field is missing from a set of fields, all of which are required to be present if any one is present. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.Missing.NeedAll Fault Options

Name

Description

fieldNames

StringListOption.

Specifies the set of fields.

Client.BadSyntax.Missing.NeedAtLeast1

At least one field from a set of possible fields is required, but all fields in the set are missing. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.Missing.NeedAtLeast1 Fault Options

Name

Description

fieldNames

StringListOption.

Specifies the set of fields, at least one of which is required.

The example from a ModifyMeetingRequest shows that it had neither an OptionList nor a RemoveList.

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadSyntax.Missing.NeedAtLeast1</FaultCode>
      <FaultString>Neither an OptionList nor a RemoveList is present.</FaultString>
      <OptionList>
         <TimeOption name="time" value="2002-07-31T05:53:47Z"/>
         <StringOption name="fieldName" value="OptionList"/>
         <StringListOption name="fieldNames">
            <String>OptionList</String>
            <String>RemoveList</String>
         </StringListOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Client.BadSyntax.MutuallyExclusive

Two or more mutually-exclusive fields are present. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.MutuallyExclusive Fault Options

Name

Description

fieldNames

StringListOption.

Specifies the set of mutually exclusive fields.

The example from a ModifyMeetingRequest shows that it had both audienceACL and audiencePassword options.

<PlaceWareConfCenter>
   <Fault>
      <FaultCode>Client.BadSyntax.MutuallyExclusive</FaultCode>
      <FaultString>Mutually exclusive options.</FaultString>
      <OptionList>
         <TimeOption name="time" value="2002-08-31T06:53:47Z"/>
         <StringOption name="fieldName" value="audienceACL"/>
         <StringListOption name="fieldNames">
            <String>audienceACL</String>
            <String>audiencePassword</String>
         </StringListOption>
      </OptionList>
   </Fault>
</PlaceWareConfCenter>

Client.BadSyntax.NotAllowed

An item is present when it is not allowed.

Client.BadSyntax.NotAllowed.Field

A field is present when it is not allowed.

Client.BadSyntax.Null

A value is null when a non-null value is required.

Client.BadSyntax.Null.ItemInList

The value of an item in a list is null when a non-null value is required. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.Null.ItemInList Fault Options

Name

Description

Index

decimalOption. Value range 0 to 231-1.

Specifies the index of the item that is null. The first item in the list has index zero.

Client.BadSyntax.ParseError

The XML could not be parsed.

Client.BadSyntax.TooFew

More values are required than are present. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooFew Fault Options

Name

Description

minNeeded

decimalOption. Value range 0 to 231-1.

Specifies the minimum number of values required.

Client.BadSyntax.TooFew.StringList

A string list contains too few strings.

Client.BadSyntax.TooHigh

A value is too large.

Client.BadSyntax.TooHigh.Integer

A decimal value is too large. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooHigh.Integer Fault Options

Name

Description

maxInteger

decimalOption.

Specifies the maximum allowed value.

Client.BadSyntax.TooLong

A value is too long. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooLong Fault Options

Name

Description

length

decimalOption. Value range 0 to 231-1.

Specifies the length.

max

decimalOption. Value range 0 to 231-1.

Specifies the maximum allowed length.

Client.BadSyntax.TooLong.ItemInList

The value of an item in a list is too long. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Table 1. Client.BadSyntax.TooLong.ItemInList Fault Options

Name

Description

index

decimalOption. Value range 0 to 231-1.

Specifies the index of the item that is too long. The first item in the list has index zero.

Client.BadSyntax.TooLong.ItemInList.String

A string in a list is too long. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooLong.ItemInList.String Fault Options

Name

Description

stringValue

StringOption.

Specifies the string value that is too long.

Client.BadSyntax.TooLong.String

A string is too long. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooLong.String Fault Options

Name

Description

stringValue

StringOption.

Specifies the string value that is too long.

Client.BadSyntax.TooLow

A value is too low.

Client.BadSyntax.TooLow.Integer

A decimal value is too low. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooLow.Integer Fault Options

Name

Description

minInteger

decimalOption.

Specifies the minimum allowed value.

Client.BadSyntax.TooLow.Time

A time value is too early. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooLow.Time Fault Options

Name

Description

minTime

TimeOption.

Specifies the earliest allowed time value.

Client.BadSyntax.TooShort

A value is too short. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooShort Fault Options

Name

Description

length

decimalOption. Value range 0 to 231-1.

Specifies the length.

min

decimalOption. Value range 0 to 231-1.

Specifies the minimum allowed length.

Client.BadSyntax.TooShort.ItemInList

The value of an item in a list is too short. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooShort.ItemInList Fault Options

Name

Description

index

decimalOption. Value range 0 to 231-1.

Specifies the index of the item that is too short. The first item in the list has index zero.

Client.BadSyntax.TooShort.ItemInList.String

A string in a list is too short. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooShort.ItemInList.String Fault Options

Name

Description

stringValue

StringOption.

Specifies the string value that is too short. This option is omitted if the string is empty.

Client.BadSyntax.TooShort.String

A string is too short. The following table specifies the options corresponding to this fault code and those below it in the hierarchy.

Client.BadSyntax.TooShort.String Fault Options

Name

Description

stringValue

StringOption.

Specifies the string value that is too short. This option is omitted if the string is empty.

See Also

Concepts

Fault Messages