XML Schema Documentation

Table of Contents

top

Schema Document Properties

Target Namespace None
Element and Attribute Namespaces
  • Global element and attribute declarations belong to this schema's target namespace.
  • By default, local element declarations belong to this schema's target namespace.
  • By default, local attribute declarations belong to this schema's target namespace.
Schema Composition

Declared Namespaces

Prefix Namespace
Default namespace
xml http://www.w3.org/XML/1998/namespace
xs http://www.w3.org/2001/XMLSchema
core C
Schema Component Representation
<xs:schema attributeFormDefault="qualified" elementFormDefault="qualified">
<xs:import namespace="C" schemaLocation="../OCISchemaBASE.xsd"/>
<xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>
...
</xs:schema>
top

Global Definitions

Complex Type: GroupCallRecordingGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallRecordingGetRequest
Abstract no
Documentation Get the Call Recording platform for a group. The response is either a GroupCallRecordingGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<groupId> GroupId </groupId> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupCallRecordingGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="groupId" type=" GroupId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallRecordingGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupCallRecordingGetResponse
Abstract no
Documentation Response to the GroupCallRecordingGetRequest. The response contains the group's Call Recording platform information.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<name> CallRecordingPlatformName </name> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupCallRecordingGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="name" type=" CallRecordingPlatformName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallRecordingModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallRecordingModifyRequest
Abstract no
Documentation Modify the Call Recording platform assignment for a group. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<groupId> GroupId </groupId> [1]
<name> CallRecordingPlatformName </name> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupCallRecordingModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="groupId" type=" GroupId "/>
<xs:element name="name" type=" CallRecordingPlatformName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemCallRecordingAddPlatformRequest19

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemCallRecordingAddPlatformRequest19
Abstract no
Documentation Add a Call Recording platform. The response is either a SuccessResponse or an ErrorResponse.
Application Data <asDataModeSupported>
true
</asDataModeSupported>
<hssDataModeSupported>
false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<name> CallRecordingPlatformName </name> [1]
<netAddress> NetAddress </netAddress> [1]
<port> Port </port> [1]
<mediaStream> MediaStream </mediaStream> [1]
<transportType> TransportProtocol </transportType> [1]
<description> CallRecordingPlatformDescription </description> [0..1]
<schemaVersion> CallRecordingPlatformSchemaVersion </schemaVersion> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemCallRecordingAddPlatformRequest19">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="name" type=" CallRecordingPlatformName "/>
<xs:element name="netAddress" type=" NetAddress "/>
<xs:element name="port" type=" Port "/>
<xs:element name="mediaStream" type=" MediaStream "/>
<xs:element name="transportType" type=" TransportProtocol "/>
<xs:element name="description" type=" CallRecordingPlatformDescription " minOccurs="0"/>
<xs:element name="schemaVersion" type=" CallRecordingPlatformSchemaVersion "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemCallRecordingDeletePlatformRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemCallRecordingDeletePlatformRequest
Abstract no
Documentation Delete a Call Recording platform. The response is either SuccessResponse or ErrorResponse.
Application Data <asDataModeSupported>
true
</asDataModeSupported>
<hssDataModeSupported>
false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<name> CallRecordingPlatformName </name> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemCallRecordingDeletePlatformRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="name" type=" CallRecordingPlatformName "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemCallRecordingGetPlatformListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemCallRecordingGetPlatformListRequest
Abstract no
Documentation Get list of Call Recording platforms. The response is either SystemCallRecordingGetPlatformListResponse or ErrorResponse.
Application Data <asDataModeSupported>
true
</asDataModeSupported>
<hssDataModeSupported>
false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<xs:complexType name="SystemCallRecordingGetPlatformListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest "/>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemCallRecordingGetPlatformListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name SystemCallRecordingGetPlatformListResponse
Abstract no
Documentation Response to SystemCallRecordingGetPlatformListRequest. Contains the default system Call Recording platform and a table with columns headings "Name", "Net Address", "Port", "Transport Type", "Media Stream", "Description" of Call Recording platforms, "Schema Version". The system default recording platform also appears in the table with the other platforms.
Application Data <asDataModeSupported>
true
</asDataModeSupported>
<hssDataModeSupported>
false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<systemDefault> CallRecordingPlatformName </systemDefault> [0..1]
<callRecordingPlatformTable> core:OCITable </callRecordingPlatformTable> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemCallRecordingGetPlatformListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="systemDefault" type=" CallRecordingPlatformName " minOccurs="0"/>
<xs:element name="callRecordingPlatformTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemCallRecordingGetPlatformUsageRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemCallRecordingGetPlatformUsageRequest
Abstract no
Documentation Get the list of groups currently associated to the specified Call Recording platform. The response is either SystemCallRecordingGetPlatformUsageResponse or ErrorResponse.
Application Data <asDataModeSupported>
true
</asDataModeSupported>
<hssDataModeSupported>
false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<name> CallRecordingPlatformName </name> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemCallRecordingGetPlatformUsageRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="name" type=" CallRecordingPlatformName "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemCallRecordingGetPlatformUsageResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name SystemCallRecordingGetPlatformUsageResponse
Abstract no
Documentation Response to SystemCallRecordingGetPlatformUsageRequest. The response contains a table with columns headings "Service Provider Id", "Group Id".
Application Data <asDataModeSupported>
true
</asDataModeSupported>
<hssDataModeSupported>
false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<groupTable> core:OCITable </groupTable> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemCallRecordingGetPlatformUsageResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="groupTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemCallRecordingModifyPlatformRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemCallRecordingModifyPlatformRequest
Abstract no
Documentation Modify the specified Call Recording platform. The response is either a SuccessResponse or an ErrorResponse.
Application Data <asDataModeSupported>
true
</asDataModeSupported>
<hssDataModeSupported>
false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<name> CallRecordingPlatformName </name> [1]
<netAddress> NetAddress </netAddress> [0..1]
<port> Port </port> [0..1]
<mediaStream> MediaStream </mediaStream> [0..1]
<becomeSystemDefault> true </becomeSystemDefault> [0..1]
<transportType> TransportProtocol </transportType> [0..1]
<description> CallRecordingPlatformDescription </description> [0..1]
<schemaVersion> CallRecordingPlatformSchemaVersion </schemaVersion> [0..1]
</...>
Schema Component Representation
<xs:complexType name="SystemCallRecordingModifyPlatformRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="name" type=" CallRecordingPlatformName "/>
<xs:element name="netAddress" type=" NetAddress " minOccurs="0"/>
<xs:element name="port" type=" Port " minOccurs="0"/>
<xs:element name="mediaStream" type=" MediaStream " minOccurs="0"/>
<xs:element name="becomeSystemDefault" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="transportType" type=" TransportProtocol " minOccurs="0"/>
<xs:element name="description" type=" CallRecordingPlatformDescription " minOccurs="0" nillable="true"/>
<xs:element name="schemaVersion" type=" CallRecordingPlatformSchemaVersion " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCallRecordingGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCallRecordingGetRequest
Abstract no
Documentation Get the Call Recording attributes for a user. The response is either a UserCallRecordingGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserCallRecordingGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCallRecordingGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserCallRecordingGetResponse
Abstract no
Documentation Response to the UserCallRecordingGetRequest. The response contains the user's Call Recording option information.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<recordingOption> RecordingOption </recordingOption> [1]
</...>
Schema Component Representation
<xs:complexType name="UserCallRecordingGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="recordingOption" type=" RecordingOption "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCallRecordingModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCallRecordingModifyRequest
Abstract no
Documentation Modify the Call Recording attributes for a user. The recording option "On Demand" is not accepted for service instances. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<recordingOption> RecordingOption </recordingOption> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserCallRecordingModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="recordingOption" type=" RecordingOption " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: CallRecordingPlatformDescription

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name CallRecordingPlatformDescription
Content
  • Base XSD Type: token
  • length >= 1
Documentation Call Recording Platform Description.
Schema Component Representation
<xs:simpleType name="CallRecordingPlatformDescription">
<xs:restriction base=" xs:token ">
<xs:minLength value="1"/>
<xs:maxLength value="80"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: CallRecordingPlatformName

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name CallRecordingPlatformName
Content
  • Base XSD Type: token
  • length >= 1
Documentation Call Recording Platform Name.
Schema Component Representation
<xs:simpleType name="CallRecordingPlatformName">
<xs:restriction base=" xs:token ">
<xs:minLength value="1"/>
<xs:maxLength value="80"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: CallRecordingPlatformSchemaVersion

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name CallRecordingPlatformSchemaVersion
Content
  • Base XSD Type: token
  • value comes from list: {'1.0'|'2.0'}
Documentation Supported versions of the BroadWorks-specific extension metadata.
Schema Component Representation
<xs:simpleType name="CallRecordingPlatformSchemaVersion">
<xs:restriction base=" xs:token ">
<xs:enumeration value="1.0"/>
<xs:enumeration value="2.0"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: MediaStream

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name MediaStream
Content
  • Base XSD Type: token
  • value comes from list: {'Dual'|'Single'}
Documentation Media Stream Type. Subscriber's media is sent separately from the media generated by the called/calling parties when "Dual" is selected while "Single" is a single media stream that contains all media.
Schema Component Representation
<xs:simpleType name="MediaStream">
<xs:restriction base=" xs:token ">
<xs:enumeration value="Dual"/>
<xs:enumeration value="Single"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: RecordingOption

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name RecordingOption
Content
  • Base XSD Type: token
  • value comes from list: {'Always'|'Never'|'On Demand'}
Documentation Recording Service Configuration.
Schema Component Representation
<xs:simpleType name="RecordingOption">
<xs:restriction base=" xs:token ">
<xs:enumeration value="Always"/>
<xs:enumeration value="Never"/>
<xs:enumeration value="On Demand"/>
</xs:restriction>
</xs:simpleType>
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.

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