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:include schemaLocation="../OCISchemaSearchCriteria.xsd"/>
...
</xs:schema>
top

Global Definitions

Complex Type: GroupCallCapacityManagementAddInstanceRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementAddInstanceRequest
Abstract no
Documentation Adds a Call Capacity Management group. The response is either SuccessResponse or 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> ServiceInstanceName </name> [1]
<maxActiveCallsAllowed> CallCapacityCallLimit </maxActiveCallsAllowed> [1]
<maxIncomingActiveCallsAllowed> CallCapacityCallLimit </maxIncomingActiveCallsAllowed> [0..1]
<maxOutgoingActiveCallsAllowed> CallCapacityCallLimit </maxOutgoingActiveCallsAllowed> [0..1]
<becomeDefaultGroupForNewUsers> xs:boolean </becomeDefaultGroupForNewUsers> [1]
<userId> UserId </userId> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementAddInstanceRequest">
<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=" ServiceInstanceName "/>
<xs:element name="maxActiveCallsAllowed" type=" CallCapacityCallLimit "/>
<xs:element name="maxIncomingActiveCallsAllowed" type=" CallCapacityCallLimit " minOccurs="0"/>
<xs:element name="maxOutgoingActiveCallsAllowed" type=" CallCapacityCallLimit " minOccurs="0"/>
<xs:element name="becomeDefaultGroupForNewUsers" type=" xs:boolean "/>
<xs:element name="userId" type=" UserId " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallCapacityManagementAddUserListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementAddUserListRequest
Abstract no
Documentation Adds one or more users to a Call Capacity Management group. The response is either SuccessResponse or 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> ServiceInstanceName </name> [1]
<userId> UserId </userId> [1..*]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementAddUserListRequest">
<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=" ServiceInstanceName "/>
<xs:element name="userId" type=" UserId " minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallCapacityManagementDeleteInstanceListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementDeleteInstanceListRequest
Abstract no
Documentation Deletes one or more Call Capacity Management groups. The response is either SuccessResponse or 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> ServiceInstanceName </name> [1..*]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementDeleteInstanceListRequest">
<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=" ServiceInstanceName " minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallCapacityManagementDeleteUserListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementDeleteUserListRequest
Abstract no
Documentation Deletes one or more users from a Call Capacity Management group. The response is either SuccessResponse or 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> ServiceInstanceName </name> [1]
<userId> UserId </userId> [1..*]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementDeleteUserListRequest">
<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=" ServiceInstanceName "/>
<xs:element name="userId" type=" UserId " minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallCapacityManagementGetAvailableUserListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementGetAvailableUserListRequest
Abstract no
Documentation Get a list of users that can be assigned to a Call Capacity Management group. The available user list for a new Call Capacity Management group can be obtained by not setting the name. The response is either GroupCallCapacityManagementGetAvailableUserListResponse or 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> ServiceInstanceName </name> [0..1]
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaUserFirstName> SearchCriteriaUserFirstName </searchCriteriaUserFirstName> [0..*]
<searchCriteriaExactUserDepartment> SearchCriteriaExactUserDepartment </searchCriteriaExactUserDepartment> [0..1]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementGetAvailableUserListRequest">
<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=" ServiceInstanceName " minOccurs="0"/>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserFirstName" type=" SearchCriteriaUserFirstName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactUserDepartment" type=" SearchCriteriaExactUserDepartment " minOccurs="0"/>
<xs:element name="searchCriteriaUserId" type=" SearchCriteriaUserId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallCapacityManagementGetAvailableUserListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementGetAvailableUserListResponse
Abstract no
Documentation Response to the GroupCallCapacityManagementGetAvailableUserListRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userTable> core:OCITable </userTable> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementGetAvailableUserListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="userTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallCapacityManagementGetInstanceListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementGetInstanceListRequest
Abstract no
Documentation Request to get a list of Call Capacity Management instances within a group. The response is either GroupCallCapacityManagementGetInstanceListResponse or 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="GroupCallCapacityManagementGetInstanceListRequest">
<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: GroupCallCapacityManagementGetInstanceListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementGetInstanceListResponse
Abstract no
Documentation Response to the GroupCallCapacityManagementGetInstanceListRequest. Contains a table with column headings: "Name", "Is Default", "Maximum Calls", "Maximum Incoming Calls", "Maximum Outgoing Calls".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<callCapacityGroupTable> core:OCITable </callCapacityGroupTable> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementGetInstanceListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="callCapacityGroupTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallCapacityManagementGetInstanceRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementGetInstanceRequest
Abstract no
Documentation Gets a Call Capacity Management group. The response is either GroupCallCapacityManagementGetInstanceResponse or 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> ServiceInstanceName </name> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementGetInstanceRequest">
<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=" ServiceInstanceName "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallCapacityManagementGetInstanceResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementGetInstanceResponse
Abstract no
Documentation Response to the GroupCallCapacityManagementGetInstanceRequest. Contains a table with column headings: "User Id", "Last Name", "First Name", "Hiragana Last Name", "Hiragana First Name", "Phone Number", "Extension", "Department", "Email Address".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<name> ServiceInstanceName </name> [1]
<maxActiveCallsAllowed> CallCapacityCallLimit </maxActiveCallsAllowed> [1]
<maxIncomingActiveCallsAllowed> CallCapacityCallLimit </maxIncomingActiveCallsAllowed> [0..1]
<maxOutgoingActiveCallsAllowed> CallCapacityCallLimit </maxOutgoingActiveCallsAllowed> [0..1]
<defaultGroupForNewUsers> xs:boolean </defaultGroupForNewUsers> [1]
<userTable> core:OCITable </userTable> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementGetInstanceResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="name" type=" ServiceInstanceName "/>
<xs:element name="maxActiveCallsAllowed" type=" CallCapacityCallLimit "/>
<xs:element name="maxIncomingActiveCallsAllowed" type=" CallCapacityCallLimit " minOccurs="0"/>
<xs:element name="maxOutgoingActiveCallsAllowed" type=" CallCapacityCallLimit " minOccurs="0"/>
<xs:element name="defaultGroupForNewUsers" type=" xs:boolean "/>
<xs:element name="userTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupCallCapacityManagementModifyInstanceRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupCallCapacityManagementModifyInstanceRequest
Abstract no
Documentation Modifies a Call Capacity Management group. Replaces the entire list of users in the group. The response is either SuccessResponse or 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> ServiceInstanceName </name> [1]
<newName> ServiceInstanceName </newName> [0..1]
<maxActiveCallsAllowed> CallCapacityCallLimit </maxActiveCallsAllowed> [0..1]
<maxIncomingActiveCallsAllowed> CallCapacityCallLimit </maxIncomingActiveCallsAllowed> [0..1]
<maxOutgoingActiveCallsAllowed> CallCapacityCallLimit </maxOutgoingActiveCallsAllowed> [0..1]
<becomeDefaultGroupForNewUsers> xs:boolean </becomeDefaultGroupForNewUsers> [0..1]
<userIdList> ReplacementUserIdList </userIdList> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupCallCapacityManagementModifyInstanceRequest">
<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=" ServiceInstanceName "/>
<xs:element name="newName" type=" ServiceInstanceName " minOccurs="0"/>
<xs:element name="maxActiveCallsAllowed" type=" CallCapacityCallLimit " minOccurs="0"/>
<xs:element name="maxIncomingActiveCallsAllowed" type=" CallCapacityCallLimit " nillable="true" minOccurs="0"/>
<xs:element name="maxOutgoingActiveCallsAllowed" type=" CallCapacityCallLimit " nillable="true" minOccurs="0"/>
<xs:element name="becomeDefaultGroupForNewUsers" type=" xs:boolean " minOccurs="0"/>
<xs:element name="userIdList" type=" ReplacementUserIdList " nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: CallCapacityCallLimit

Parent type: xs:int (derivation method: restriction)
Sub-types: None
Name CallCapacityCallLimit
Content
  • Base XSD Type: int
  • 0 <= value <= 99999
Documentation Range of values for the call capacity of a capacity group.
Schema Component Representation
<xs:simpleType name="CallCapacityCallLimit">
<xs:restriction base=" xs:int ">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="99999"/>
</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