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: SystemAutomaticCallbackAddReleaseCauseListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemAutomaticCallbackAddReleaseCauseListRequest
Abstract no
Documentation Adds automatic callback release cause to the releaseCause attribute. 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. -->
<releaseCause> AutomaticCallbackReleaseCause </releaseCause> [0..*]
</...>
Schema Component Representation
<xs:complexType name="SystemAutomaticCallbackAddReleaseCauseListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="releaseCause" type=" AutomaticCallbackReleaseCause " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemAutomaticCallbackDeleteReleaseCauseListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemAutomaticCallbackDeleteReleaseCauseListRequest
Abstract no
Documentation Deletes automatic callback release causes from the release cause attribute. 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. -->
<releaseCause> AutomaticCallbackReleaseCause </releaseCause> [0..*]
</...>
Schema Component Representation
<xs:complexType name="SystemAutomaticCallbackDeleteReleaseCauseListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="releaseCause" type=" AutomaticCallbackReleaseCause " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemAutomaticCallbackGetReleaseCauseListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemAutomaticCallbackGetReleaseCauseListRequest
Abstract no
Documentation Request the system's automatic callback attributes. The response is either a SystemAutomaticCallbackGetReleaseCauseListResponse or an ErrorResponse.
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="SystemAutomaticCallbackGetReleaseCauseListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemAutomaticCallbackGetReleaseCauseListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name SystemAutomaticCallbackGetReleaseCauseListResponse
Abstract no
Documentation Response to SystemAutomaticCallbackGetReleaseCauseListRequest.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<releaseCause> AutomaticCallbackReleaseCause </releaseCause> [0..*]
</...>
Schema Component Representation
<xs:complexType name="SystemAutomaticCallbackGetReleaseCauseListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="releaseCause" type=" AutomaticCallbackReleaseCause " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemAutomaticCallbackGetRequest17

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemAutomaticCallbackGetRequest17
Abstract no
Documentation Request the system's automatic callback attributes. The response is either a SystemAutomaticCallbackGetResponse17 or an ErrorResponse.
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="SystemAutomaticCallbackGetRequest17">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence/>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemAutomaticCallbackGetResponse17

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name SystemAutomaticCallbackGetResponse17
Abstract no
Documentation Response to SystemAutomaticCallbackGetRequest17.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<monitorMinutes> AutomaticCallbackMonitorMinutes </monitorMinutes> [1]
<maxMonitorsPerOriginator> AutomaticCallbackMaxMonitorsPerOriginator </maxMonitorsPerOriginator> [1]
<maxCallbackRings> AutomaticCallbackMaxCallbackRings </maxCallbackRings> [1]
<maxMonitorsPerTerminator> AutomaticCallbackMaxMonitorsPerTerminator </maxMonitorsPerTerminator> [1]
<terminatorIdleGuardSeconds> AutomaticCallbackTerminatorIdleGuardSeconds </terminatorIdleGuardSeconds> [1]
<callbackMethod> AutomaticCallbackMethod </callbackMethod> [1]
<pollingIntervalSeconds> AutomaticCallbackPollingIntervalSeconds </pollingIntervalSeconds> [1]
<activationDigit> AutomaticCallbackActivationDigit </activationDigit> [1]
</...>
Schema Component Representation
<xs:complexType name="SystemAutomaticCallbackGetResponse17">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="monitorMinutes" type=" AutomaticCallbackMonitorMinutes "/>
<xs:element name="maxMonitorsPerOriginator" type=" AutomaticCallbackMaxMonitorsPerOriginator "/>
<xs:element name="maxCallbackRings" type=" AutomaticCallbackMaxCallbackRings "/>
<xs:element name="maxMonitorsPerTerminator" type=" AutomaticCallbackMaxMonitorsPerTerminator "/>
<xs:element name="terminatorIdleGuardSeconds" type=" AutomaticCallbackTerminatorIdleGuardSeconds "/>
<xs:element name="callbackMethod" type=" AutomaticCallbackMethod "/>
<xs:element name="pollingIntervalSeconds" type=" AutomaticCallbackPollingIntervalSeconds "/>
<xs:element name="activationDigit" type=" AutomaticCallbackActivationDigit "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: SystemAutomaticCallbackModifyRequest15

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name SystemAutomaticCallbackModifyRequest15
Abstract no
Documentation Modifies the system's automatic callback attributes. 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. -->
<monitorMinutes> AutomaticCallbackMonitorMinutes </monitorMinutes> [0..1]
<maxMonitorsPerOriginator> AutomaticCallbackMaxMonitorsPerOriginator </maxMonitorsPerOriginator> [0..1]
<maxCallbackRings> AutomaticCallbackMaxCallbackRings </maxCallbackRings> [0..1]
<maxMonitorsPerTerminator> AutomaticCallbackMaxMonitorsPerTerminator </maxMonitorsPerTerminator> [0..1]
<terminatorIdleGuardSeconds> AutomaticCallbackTerminatorIdleGuardSeconds </terminatorIdleGuardSeconds> [0..1]
<callbackMethod> AutomaticCallbackMethod </callbackMethod> [0..1]
<pollingIntervalSeconds> AutomaticCallbackPollingIntervalSeconds </pollingIntervalSeconds> [0..1]
<activationDigit> AutomaticCallbackActivationDigit </activationDigit> [0..1]
</...>
Schema Component Representation
<xs:complexType name="SystemAutomaticCallbackModifyRequest15">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="monitorMinutes" type=" AutomaticCallbackMonitorMinutes " minOccurs="0"/>
<xs:element name="maxMonitorsPerOriginator" type=" AutomaticCallbackMaxMonitorsPerOriginator " minOccurs="0"/>
<xs:element name="maxCallbackRings" type=" AutomaticCallbackMaxCallbackRings " minOccurs="0"/>
<xs:element name="maxMonitorsPerTerminator" type=" AutomaticCallbackMaxMonitorsPerTerminator " minOccurs="0"/>
<xs:element name="terminatorIdleGuardSeconds" type=" AutomaticCallbackTerminatorIdleGuardSeconds " minOccurs="0"/>
<xs:element name="callbackMethod" type=" AutomaticCallbackMethod " minOccurs="0"/>
<xs:element name="pollingIntervalSeconds" type=" AutomaticCallbackPollingIntervalSeconds " minOccurs="0"/>
<xs:element name="activationDigit" type=" AutomaticCallbackActivationDigit " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAutomaticCallbackGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAutomaticCallbackGetRequest
Abstract no
Documentation Request the user level data associated with Automatic Callback. The response is either a UserAutomaticCallbackGetResponse 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="UserAutomaticCallbackGetRequest">
<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: UserAutomaticCallbackGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserAutomaticCallbackGetResponse
Abstract no
Documentation Response to UserAutomaticCallbackGetRequest.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<isActive> xs:boolean </isActive> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAutomaticCallbackGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="isActive" type=" xs:boolean "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAutomaticCallbackModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAutomaticCallbackModifyRequest
Abstract no
Documentation Modify the user level data associated with Automatic Callback. 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]
<isActive> xs:boolean </isActive> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserAutomaticCallbackModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="isActive" type=" xs:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: AutomaticCallbackActivationDigit

Parent type: xs:int (derivation method: restriction)
Sub-types: None
Name AutomaticCallbackActivationDigit
Content
  • Base XSD Type: int
  • 0 <= value <= 9
Documentation Callback Activation Digit.
Schema Component Representation
<xs:simpleType name="AutomaticCallbackActivationDigit">
<xs:restriction base=" xs:int ">
<xs:minInclusive value="0"/>
<xs:maxInclusive value="9"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: AutomaticCallbackMaxCallbackRings

Parent type: xs:int (derivation method: restriction)
Sub-types: None
Name AutomaticCallbackMaxCallbackRings
Content
  • Base XSD Type: int
  • 3 <= value <= 8
Documentation Maximum callback rings.
Schema Component Representation
<xs:simpleType name="AutomaticCallbackMaxCallbackRings">
<xs:restriction base=" xs:int ">
<xs:minInclusive value="3"/>
<xs:maxInclusive value="8"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: AutomaticCallbackMaxMonitorsPerOriginator

Parent type: xs:int (derivation method: restriction)
Sub-types: None
Name AutomaticCallbackMaxMonitorsPerOriginator
Content
  • Base XSD Type: int
  • 1 <= value <= 30
Documentation Maximum monitors per originator.
Schema Component Representation
<xs:simpleType name="AutomaticCallbackMaxMonitorsPerOriginator">
<xs:restriction base=" xs:int ">
<xs:minInclusive value="1"/>
<xs:maxInclusive value="30"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: AutomaticCallbackMaxMonitorsPerTerminator

Parent type: xs:int (derivation method: restriction)
Sub-types: None
Name AutomaticCallbackMaxMonitorsPerTerminator
Content
  • Base XSD Type: int
  • 1 <= value <= 30
Documentation Maximum monitors per terminator.
Schema Component Representation
<xs:simpleType name="AutomaticCallbackMaxMonitorsPerTerminator">
<xs:restriction base=" xs:int ">
<xs:minInclusive value="1"/>
<xs:maxInclusive value="30"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: AutomaticCallbackMethod

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name AutomaticCallbackMethod
Content
  • Base XSD Type: token
  • value comes from list: {'Notify Only'|'Notify If Possible And Polling Otherwise'}
Documentation Automatic Callback methods.
Schema Component Representation
<xs:simpleType name="AutomaticCallbackMethod">
<xs:restriction base=" xs:token ">
<xs:enumeration value="Notify Only"/>
<xs:enumeration value="Notify If Possible And Polling Otherwise"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: AutomaticCallbackMonitorMinutes

Parent type: xs:int (derivation method: restriction)
Sub-types: None
Name AutomaticCallbackMonitorMinutes
Content
  • Base XSD Type: int
  • 5 <= value <= 180
Documentation Automatic Callback monitor minutes.
Schema Component Representation
<xs:simpleType name="AutomaticCallbackMonitorMinutes">
<xs:restriction base=" xs:int ">
<xs:minInclusive value="5"/>
<xs:maxInclusive value="180"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: AutomaticCallbackPollingIntervalSeconds

Parent type: xs:int (derivation method: restriction)
Sub-types: None
Name AutomaticCallbackPollingIntervalSeconds
Content
  • Base XSD Type: int
  • 60 <= value <= 900
Documentation Polling interval seconds.
Schema Component Representation
<xs:simpleType name="AutomaticCallbackPollingIntervalSeconds">
<xs:restriction base=" xs:int ">
<xs:minInclusive value="60"/>
<xs:maxInclusive value="900"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: AutomaticCallbackReleaseCause

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name AutomaticCallbackReleaseCause
Content
  • Base XSD Type: token
  • value comes from list: {'Busy'|'Forbidden'|'Global Failure'|'Request Failure'|'Server Failure'|'Translation Failure'|'Temporarily Unavailable'|'User Not Found'|'Request Timeout'}
Documentation Callback Release Cause.
Schema Component Representation
<xs:simpleType name="AutomaticCallbackReleaseCause">
<xs:restriction base=" xs:token ">
<xs:enumeration value="Busy"/>
<xs:enumeration value="Forbidden"/>
<xs:enumeration value="Global Failure"/>
<xs:enumeration value="Request Failure"/>
<xs:enumeration value="Server Failure"/>
<xs:enumeration value="Translation Failure"/>
<xs:enumeration value="Temporarily Unavailable"/>
<xs:enumeration value="User Not Found"/>
<xs:enumeration value="Request Timeout"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: AutomaticCallbackTerminatorIdleGuardSeconds

Parent type: xs:int (derivation method: restriction)
Sub-types: None
Name AutomaticCallbackTerminatorIdleGuardSeconds
Content
  • Base XSD Type: int
  • 5 <= value <= 300
Documentation Idle guard timer seconds.
Schema Component Representation
<xs:simpleType name="AutomaticCallbackTerminatorIdleGuardSeconds">
<xs:restriction base=" xs:int ">
<xs:minInclusive value="5"/>
<xs:maxInclusive value="300"/>
</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