# XML Schema Documentation

Printer-friendly Version
XML Instance Representation:
[ Expand All | Collapse All ]
Schema Component Representation:
[ Expand All | Collapse All ]

## Table of Contents

- Schema Document Properties
- Global Declarations
  - Element: BroadsoftDocument
- Global Definitions
  - Complex Type: ErrorResponse
  - Complex Type: OCICommand
  - Complex Type: OCIDataResponse
  - Complex Type: OCIMessage
  - Complex Type: OCIRequest
  - Complex Type: OCIResponse
  - Complex Type: OCITable
  - Complex Type: OCITableRow
  - Complex Type: SuccessResponse

- Legend

- Glossary

top

## Schema Document Properties

Target Namespace | C
Element and Attribute Namespaces | Global element and attribute declarations belong to this schema's target namespace. By default, local element declarations have no namespace. By default, local attribute declarations have no namespace.
Schema Composition | This schema includes components from the following schema document(s): OCISchemaHiddenBASE.xsd

### Declared Namespaces

Prefix | Namespace
--- | ---
Default namespace | C
xml | http://www.w3.org/XML/1998/namespace
xs | http://www.w3.org/2001/XMLSchema

Schema Component Representation
<xs:schema targetNamespace="C">
<xs:include schemaLocation="OCISchemaHiddenBASE.xsd"/>
...
</xs:schema>
top

## Global Declarations

### Element: BroadsoftDocument

Name | BroadsoftDocument
Type | OCIMessage
Nillable | no
Abstract | no
Documentation | Every Message starts with a BroadsoftDocument tag.

XML Instance Representation
<BroadsoftDocument
protocol=" xs:NMTOKEN (value comes from list: {'OCI'|'NSOCI'}) [1]">
Start Choice [1]
<sessionId> xs:normalizedString </sessionId> [1] ?
<userId> xs:token </userId> [1] ?
<phoneNumber> xs:token </phoneNumber> [1] ?
End Choice
<command> OCICommand </command> [1..15] ?
</BroadsoftDocument>
Schema Component Representation
<xs:element name="BroadsoftDocument" type=" OCIMessage "/>
top

## Global Definitions

### Complex Type: ErrorResponse

Parent type: | OCIResponse (derivation method: extension)
Sub-types: | None

Name | ErrorResponse
Abstract | no
Documentation | The ErrorResponse is concrete response sent whenever a transaction fails and does not return any data.
Application Data

XML Instance Representation
<...
echo=" xs:string [0..1] ?"
debugInfo=" xs:string [0..1] ?"
type=" xs:NMTOKEN (value comes from list: {'Error'|'Warning'|'Info'}) [1]">
<errorCode> xs:int </errorCode> [0..1]
<summary> xs:string </summary> [1]
<summaryEnglish> xs:string </summaryEnglish> [1]
<detail> xs:string </detail> [0..1]
</...>
Schema Component Representation
<xs:complexType name="ErrorResponse">
<xs:complexContent>
<xs:extension base=" OCIResponse ">
<xs:sequence>
<xs:element name="errorCode" type=" xs:int " minOccurs="0"/>
<xs:element name="summary" type=" xs:string "/>
<xs:element name="summaryEnglish" type=" xs:string "/>
<xs:element name="detail" type=" xs:string " minOccurs="0"/>
</xs:sequence>
<xs:attribute name="type" use="required">
<xs:simpleType>
<xs:restriction base=" xs:NMTOKEN ">
<xs:enumeration value="Error"/>
<xs:enumeration value="Warning"/>
<xs:enumeration value="Info"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: OCICommand

Parent type: | None
Sub-types: | OCIRequest (by extension) OCIResponse (by extension) OCIDataResponse (by extension) SuccessResponse (by extension) ErrorResponse (by extension)

Name | OCICommand
Abstract | yes
Documentation | The OCICommand is an abstract type from which all requests and responses are derived.
Application Data |

XML Instance Representation
<...
echo=" xs:string [0..1] ?"/>
Schema Component Representation
<xs:complexType name="OCICommand" abstract="true">
<xs:sequence/>
<xs:attribute name="echo" type=" xs:string " use="optional"/>
</xs:complexType>
top

### Complex Type: OCIDataResponse

Parent type: | OCIResponse (derivation method: extension)
Sub-types: | None

Name | OCIDataResponse
Abstract | yes
Documentation | The OCIDataResponse is an abstract base type for all responses containing some sort of data other than merely a success or failure indication.
Application Data |

XML Instance Representation
<...
echo=" xs:string [0..1] ?"
debugInfo=" xs:string [0..1] ?"/>
Schema Component Representation
<xs:complexType name="OCIDataResponse" abstract="true">
<xs:complexContent>
<xs:extension base=" OCIResponse ">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: OCIMessage

Parent type: | None
Sub-types: | None

Name | OCIMessage
Abstract | no
Documentation | A message contains a list of requests or responses. The server processes all the requests and returns a message with a corresponding list of responses.
Application Data |

XML Instance Representation
<...
protocol=" xs:NMTOKEN (value comes from list: {'OCI'|'NSOCI'}) [1]">
Start Choice [1]
<sessionId> xs:normalizedString </sessionId> [1] ?
<userId> xs:token </userId> [1] ?
<phoneNumber> xs:token </phoneNumber> [1] ?
End Choice
<command> OCICommand </command> [1..15] ?
</...>
Schema Component Representation
<xs:complexType name="OCIMessage">
<xs:sequence>
<xs:choice>
<xs:element name="sessionId" type=" xs:normalizedString "/>
<xs:element name="userId" type=" xs:token "/>
<xs:element name="phoneNumber" type=" xs:token "/>
</xs:choice>
<xs:element name="command" type=" OCICommand " minOccurs="1" maxOccurs="15"/>
</xs:sequence>
<xs:attribute name="protocol" use="required">
<xs:simpleType>
<xs:restriction base=" xs:NMTOKEN ">
<xs:enumeration value="OCI"/>
<xs:enumeration value="NSOCI"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
</xs:complexType>
top

### Complex Type: OCIRequest

Parent type: | OCICommand (derivation method: extension)
Sub-types: | None

Name | OCIRequest
Abstract | yes
Documentation | The OCIRequest is an abstract type from which all requests are derived.
Application Data |

XML Instance Representation
<...
echo=" xs:string [0..1] ?"/>
Schema Component Representation
<xs:complexType name="OCIRequest" abstract="true">
<xs:complexContent>
<xs:extension base=" OCICommand ">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: OCIResponse

Parent type: | OCICommand (derivation method: extension)
Sub-types: | OCIDataResponse (by extension) SuccessResponse (by extension) ErrorResponse (by extension)

Name | OCIResponse
Abstract | yes
Documentation | The OCIResponse is an abstract type from which all responses are derived.
Application Data |

XML Instance Representation
<...
echo=" xs:string [0..1] ?"
debugInfo=" xs:string [0..1] ?"/>
Schema Component Representation
<xs:complexType name="OCIResponse" abstract="true">
<xs:complexContent>
<xs:extension base=" OCICommand ">
<xs:sequence/>
<xs:attribute name="debugInfo" type=" xs:string " use="optional"/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

### Complex Type: OCITable

Parent type: | None
Sub-types: | None

Name | OCITable
Abstract | no
Documentation | The OCITable type is used in responses only, never in requests. The table consists of rows and columns of strings. Each column has a column heading. Clients should search the column headings to find a particular column. Clients should not assume any particular column order as future revisions of the protocol may move or add columns.
Application Data |

XML Instance Representation
<...>
<colHeading> xs:string </colHeading> [1..*]
<row> OCITableRow </row> [0..*]
</...>
Schema Component Representation
<xs:complexType name="OCITable">
<xs:sequence>
<xs:element name="colHeading" type=" xs:string " minOccurs="1" maxOccurs="unbounded"/>
<xs:element name="row" type=" OCITableRow " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

### Complex Type: OCITableRow

Parent type: | None
Sub-types: | None

Name | OCITableRow
Abstract | no
Documentation | The OCITableRow type is used in responses only, never in requests. It occurs inside the OCITable type. The OCITableRow consists columns of strings. Clients should not assume any particular column order as future revisions of the protocol may move or add columns. See the OCITable data type for more information.
Application Data |

XML Instance Representation
<...>
<col> xs:string </col> [1..*]
</...>
Schema Component Representation
<xs:complexType name="OCITableRow">
<xs:sequence>
<xs:element name="col" type=" xs:string " minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

### Complex Type: SuccessResponse

Parent type: | OCIResponse (derivation method: extension)
Sub-types: | None

Name | SuccessResponse
Abstract | no
Documentation | The SuccessResponse is concrete response sent whenever a transaction is successful and does not return any data.
Application Data |

XML Instance Representation
<...
echo=" xs:string [0..1] ?"
debugInfo=" xs:string [0..1] ?"/>
Schema Component Representation
<xs:complexType name="SuccessResponse">
<xs:complexContent>
<xs:extension base=" OCIResponse ">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

## Legend

### Complex Type:

Schema Component Type

### AusAddress

Schema Component Name

Parent type: | Address (derivation method: extension)
Sub-types: | QLDAddress (by restriction)

If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.

Name | AusAddress
Abstract | no

The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

- The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
- Model group information are shown in gray, e.g. Start Choice ... End Choice.
- For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
- If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
- Otherwise, the type of the element/attribute is displayed.
  - If the element/attribute's type is in the schema, a link is provided to it.
  - For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
- If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

## Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an `xsi:type` attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the `xsi:nil` attribute. The `xsi:nil` attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an `xsi:nil` attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top