Table of Contents
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
This schema imports schema(s) from the following namespace(s):
This schema includes components from the following schema document(s):
Declared Namespaces
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:include schemaLocation ="OCISchemaServiceCallCenter.xsd "/>
...
</
xs:schema >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointAddDNISRequest
Abstract
no
Documentation
Add a Route Point DNIS.
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. -->
<dnisPhoneNumber>
DN
</dnisPhoneNumber>
[0..1]
<useCustomCLIDSettings>
xs :boolean </useCustomCLIDSettings>
[1]
<callingLineIdPhoneNumber>
DN
</callingLineIdPhoneNumber>
[0..1]
<useCustomDnisAnnouncementSettings>
xs :boolean </useCustomDnisAnnouncementSettings>
[1]
<allowOutgoingACDCall>
xs :boolean </allowOutgoingACDCall>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointAddDNISRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
dnisKey "
type ="
DNISKey
"/>
<
xs:element name ="
dnisPhoneNumber "
type ="
DN
"
minOccurs ="
0 "/>
<
xs:element name ="
extension "
type ="
Extension17
"
minOccurs ="
0 "/>
<
xs:element name ="
useCustomCLIDSettings "
type ="
xs :boolean
"/>
<
xs:element name ="
callingLineIdPhoneNumber "
type ="
DN
"
minOccurs ="
0 "/>
<
xs:element name ="
useCustomDnisAnnouncementSettings "
type ="
xs :boolean
"/>
<
xs:element name ="
allowOutgoingACDCall "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointAddInstanceRequest
Abstract
no
Documentation
Add a Route Point instance to a group.
The Route Point is a Call Center queue that performs the same function but
allows an external system to perform the distribution of calls instead of making
those decisions itself.
The domain is required in the serviceUserId.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<externalPreferredAudioCodec>
AudioFileCodec
</externalPreferredAudioCodec>
[1]
<internalPreferredAudioCodec>
AudioFileCodec
</internalPreferredAudioCodec>
[1]
<enableVideo>
xs :boolean </enableVideo>
[1]
<playRingingWhenOfferingCall>
xs :boolean </playRingingWhenOfferingCall>
[1]
<overrideAgentWrapUpTime>
xs :boolean </overrideAgentWrapUpTime>
[1]
<enableAutomaticStateChangeForAgents>
xs :boolean </enableAutomaticStateChangeForAgents>
[1]
<forceDeliveryOfCalls>
xs :boolean </forceDeliveryOfCalls>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointAddInstanceRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
externalPreferredAudioCodec "
type ="
AudioFileCodec
"/>
<
xs:element name ="
internalPreferredAudioCodec "
type ="
AudioFileCodec
"/>
<
xs:element name ="
enableVideo "
type ="
xs :boolean
"/>
<
xs:element name ="
playRingingWhenOfferingCall "
type ="
xs :boolean
"/>
<
xs:element name ="
overrideAgentWrapUpTime "
type ="
xs :boolean
"/>
<
xs:element name ="
enableAutomaticStateChangeForAgents "
type ="
xs :boolean
"/>
<
xs:element name ="
forceDeliveryOfCalls "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointBouncedCallGetRequest
Abstract
no
Documentation
Get a route point's bounced call settings.
The response is either a GroupRoutePointBouncedCallGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointBouncedCallGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointBouncedCallGetResponse
Abstract
no
Documentation
Response to the GroupRoutePointBouncedCallGetRequest.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<isActive>
xs :boolean </isActive>
[1]
<numberOfRingsBeforeBouncingCall>
HuntNoAnswerRings
</numberOfRingsBeforeBouncingCall>
[1]
<enableTransfer>
xs :boolean </enableTransfer>
[0..1]
<bounceCallWhenAgentUnavailable>
xs :boolean </bounceCallWhenAgentUnavailable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointBouncedCallGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
isActive "
type ="
xs :boolean
"/>
<
xs:element name ="
enableTransfer "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
bounceCallWhenAgentUnavailable "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointBouncedCallModifyRequest
Abstract
no
Documentation
Modify a route point's bounced call settings.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<isActive>
xs :boolean </isActive>
[0..1]
<numberOfRingsBeforeBouncingCall>
HuntNoAnswerRings
</numberOfRingsBeforeBouncingCall>
[0..1]
<enableTransfer>
xs :boolean </enableTransfer>
[0..1]
<bounceCallWhenAgentUnavailable>
xs :boolean </bounceCallWhenAgentUnavailable>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointBouncedCallModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
isActive "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
numberOfRingsBeforeBouncingCall "
type ="
HuntNoAnswerRings
"
minOccurs ="
0 "/>
<
xs:element name ="
enableTransfer "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
transferPhoneNumber "
type ="
OutgoingDNorSIPURI
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
bounceCallWhenAgentUnavailable "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointDeleteDNISRequest
Abstract
no
Documentation
Delete a route point's DNIS.
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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointDeleteDNISRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
dnisKey "
type ="
DNISKey
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointDeleteInstanceRequest
Abstract
no
Documentation
Delete a Route Point instance from a 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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointDeleteInstanceRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointDistinctiveRingingGetRequest
Abstract
no
Documentation
Get the distinctive ringing configuration values for route point.
The response is either a GroupRoutePointDistinctiveRingingGetResponse
or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointDistinctiveRingingGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointDistinctiveRingingGetResponse
Abstract
no
Documentation
Response to the GroupRoutePointDistinctiveRingingGetRequest.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<enableDistinctiveRinging>
xs :boolean </enableDistinctiveRinging>
[1]
<distinctiveRingingRingPattern>
RingPattern
</distinctiveRingingRingPattern>
[1]
<distinctiveRingingForceDeliveryRingPattern>
RingPattern
</distinctiveRingingForceDeliveryRingPattern>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointDistinctiveRingingGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
enableDistinctiveRinging "
type ="
xs :boolean
"/>
<
xs:element name ="
distinctiveRingingRingPattern "
type ="
RingPattern
"/>
<
xs:element name ="
distinctiveRingingForceDeliveryRingPattern "
type ="
RingPattern
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointDistinctiveRingingModifyRequest
Abstract
no
Documentation
Modify the distinctive ringing configuration values for route point.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<enableDistinctiveRinging>
xs :boolean </enableDistinctiveRinging>
[0..1]
<distinctiveRingingRingPattern>
RingPattern
</distinctiveRingingRingPattern>
[0..1]
<distinctiveRingingForceDeliveryRingPattern>
RingPattern
</distinctiveRingingForceDeliveryRingPattern>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointDistinctiveRingingModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
enableDistinctiveRinging "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
distinctiveRingingRingPattern "
type ="
RingPattern
"
minOccurs ="
0 "/>
<
xs:element name ="
distinctiveRingingForceDeliveryRingPattern "
type ="
RingPattern
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointForcedForwardingGetRequest20
Abstract
no
Documentation
Get a route point's forced forwarding settings.
The response is either a GroupRoutePointForcedForwardingGetResponse20 or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointForcedForwardingGetRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointForcedForwardingGetResponse20
Abstract
no
Documentation
Response to the GroupRoutePointForcedForwardingGetRequest20.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<isActive>
xs :boolean </isActive>
[1]
<playAnnouncementBeforeForwarding>
xs :boolean </playAnnouncementBeforeForwarding>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointForcedForwardingGetResponse20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
isActive "
type ="
xs :boolean
"/>
<
xs:element name ="
playAnnouncementBeforeForwarding "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointForcedForwardingModifyRequest20
Abstract
no
Documentation
Modify a route point's forced forwarding settings.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<isActive>
xs :boolean </isActive>
[0..1]
<playAnnouncementBeforeForwarding>
xs :boolean </playAnnouncementBeforeForwarding>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointForcedForwardingModifyRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
isActive "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
forwardToPhoneNumber "
type ="
OutgoingDNorSIPURI
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
playAnnouncementBeforeForwarding "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointGetAnnouncementRequest20
Abstract
no
Documentation
Get a route point's announcement settings.
The response is either a GroupRoutePointGetAnnouncementResponse20 or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetAnnouncementRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointGetAnnouncementResponse20
Abstract
no
Documentation
Response to the GroupRoutePointGetAnnouncementRequest20.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetAnnouncementResponse20 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointGetDNISAgentListRequest
Abstract
no
Documentation
Get a list of agent who selected the DNIS as the outgoing call.
The response is either GroupRoutePointGetDNISAgentListResponse or 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 ="
GroupRoutePointGetDNISAgentListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
dnisKey "
type ="
DNISKey
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointGetDNISAgentListResponse
Abstract
no
Documentation
Response to the GroupRoutePointGetDNISAgentListRequest.
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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetDNISAgentListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointGetDNISAnnouncementRequest20
Abstract
no
Documentation
Get a route point's DNIS Announcements
The response is either a GroupRoutePointGetDNISAnnouncementResponse20 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 ="
GroupRoutePointGetDNISAnnouncementRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
dnisKey "
type ="
DNISKey
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointGetDNISAnnouncementResponse20
Abstract
no
Documentation
Response to the GroupRoutePointGetDNISAnnouncementRequest20.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetDNISAnnouncementResponse20 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointGetDNISListRequest
Abstract
no
Documentation
Get a list of DNIS that are configured for a Route Point.
The response is either GroupRoutePointGetDNISListResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetDNISListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointGetDNISListResponse
Abstract
no
Documentation
Response to the GroupRoutePointGetDNISListRequest.
Contains a table with column headings: "Name", "Phone Number", "Extension".
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<displayDNISNumber>
xs :boolean </displayDNISNumber>
[1]
<displayDNISName>
xs :boolean </displayDNISName>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetDNISListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
displayDNISNumber "
type ="
xs :boolean
"/>
<
xs:element name ="
displayDNISName "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointGetDNISRequest
Abstract
no
Documentation
Get a route point's DNIS.
The response is either a GroupRoutePointGetDNISResponse 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 ="
GroupRoutePointGetDNISRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
dnisKey "
type ="
DNISKey
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointGetDNISResponse
Abstract
no
Documentation
Response to the GroupRoutePointGetDNISRequest.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<dnisPhoneNumber>
DN
</dnisPhoneNumber>
[0..1]
<useCustomCLIDSettings>
xs :boolean </useCustomCLIDSettings>
[1]
<callingLineIdPhoneNumber>
DN
</callingLineIdPhoneNumber>
[0..1]
<useCustomDnisAnnouncementSettings>
xs :boolean </useCustomDnisAnnouncementSettings>
[1]
<allowOutgoingACDCall>
xs :boolean </allowOutgoingACDCall>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetDNISResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
dnisPhoneNumber "
type ="
DN
"
minOccurs ="
0 "/>
<
xs:element name ="
extension "
type ="
Extension17
"
minOccurs ="
0 "/>
<
xs:element name ="
useCustomCLIDSettings "
type ="
xs :boolean
"/>
<
xs:element name ="
callingLineIdPhoneNumber "
type ="
DN
"
minOccurs ="
0 "/>
<
xs:element name ="
useCustomDnisAnnouncementSettings "
type ="
xs :boolean
"/>
<
xs:element name ="
allowOutgoingACDCall "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointGetFailoverPolicyRequest
Abstract
no
Documentation
Get the route point failover policy.
The response is either a GroupRoutePointGetFailoverPolicyResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetFailoverPolicyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointGetFailoverPolicyResponse
Abstract
no
Documentation
Response to the GroupRoutePointGetFailoverPolicyRequest.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<enableFailoverSupport>
xs :boolean </enableFailoverSupport>
[1]
<perCallEnableFailoverSupport>
xs :boolean </perCallEnableFailoverSupport>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetFailoverPolicyResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
enableFailoverSupport "
type ="
xs :boolean
"/>
<
xs:element name ="
perCallEnableFailoverSupport "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointGetInstanceListRequest
Abstract
no
Documentation
Get a list of Route Point instances within a group.
It is possible to search by various criteria to restrict the number of rows returned.
The response is either GroupRoutePointGetInstanceListResponse or ErrorResponse.
It is possible to get the instances within a specified department.
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 ="
GroupRoutePointGetInstanceListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
groupDepartmentName "
type ="
DepartmentName
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointGetInstanceListResponse
Abstract
no
Documentation
Response to the GroupRoutePointGetInstanceListRequest.
Contains a table with column headings:
"Service User Id", "Name", "Video", "Phone Number", "Extension", "Department", "Is Active".
The column values for "Video" and "Is Active" can either be true, or false.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetInstanceListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointGetInstanceRequest19sp1
Abstract
no
Documentation
Request to get all the information of a Route Point instance.
The response is either GroupRoutePointGetInstanceResponse19sp1 or ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetInstanceRequest19sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointGetInstanceResponse19sp1
Abstract
no
Documentation
Response to GroupRoutePointGetInstanceRequest19sp1.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<externalPreferredAudioCodec>
AudioFileCodec
</externalPreferredAudioCodec>
[1]
<internalPreferredAudioCodec>
AudioFileCodec
</internalPreferredAudioCodec>
[1]
<enableVideo>
xs :boolean </enableVideo>
[1]
<playRingingWhenOfferingCall>
xs :boolean </playRingingWhenOfferingCall>
[1]
<overrideAgentWrapUpTime>
xs :boolean </overrideAgentWrapUpTime>
[1]
<enableAutomaticStateChangeForAgents>
xs :boolean </enableAutomaticStateChangeForAgents>
[1]
<forceDeliveryOfCalls>
xs :boolean </forceDeliveryOfCalls>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointGetInstanceResponse19sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
externalPreferredAudioCodec "
type ="
AudioFileCodec
"/>
<
xs:element name ="
internalPreferredAudioCodec "
type ="
AudioFileCodec
"/>
<
xs:element name ="
enableVideo "
type ="
xs :boolean
"/>
<
xs:element name ="
playRingingWhenOfferingCall "
type ="
xs :boolean
"/>
<
xs:element name ="
overrideAgentWrapUpTime "
type ="
xs :boolean
"/>
<
xs:element name ="
enableAutomaticStateChangeForAgents "
type ="
xs :boolean
"/>
<
xs:element name ="
forceDeliveryOfCalls "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointHolidayServiceGetRequest20
Abstract
no
Documentation
Get a route point's holiday service settings.
The response is either a GroupRoutePointHolidayServiceGetResponse20 or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointHolidayServiceGetRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointHolidayServiceGetResponse20
Abstract
no
Documentation
Response to the GroupRoutePointHolidayServiceGetRequest20.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<playAnnouncementBeforeAction>
xs :boolean </playAnnouncementBeforeAction>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointHolidayServiceGetResponse20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
holidaySchedule "
type ="
HolidaySchedule
"
minOccurs ="
0 "/>
<
xs:element name ="
playAnnouncementBeforeAction "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointHolidayServiceModifyRequest20
Abstract
no
Documentation
Modify a route point's holiday service settings.
Only Group and Enterprise level schedules are accepted.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<playAnnouncementBeforeAction>
xs :boolean </playAnnouncementBeforeAction>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointHolidayServiceModifyRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
holidaySchedule "
type ="
HolidaySchedule
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
transferPhoneNumber "
type ="
OutgoingDNorSIPURI
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
playAnnouncementBeforeAction "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointManualFailoverRequest
Abstract
no
Documentation
Initiate manual failover for the Route Point.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointManualFailoverRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointModifyActiveInstanceListRequest
Abstract
no
Documentation
Request to set the active status of Route Point instances.
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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointModifyActiveInstanceListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceActivation "
type ="
ServiceActivation
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointModifyAnnouncementRequest20
Abstract
no
Documentation
Modify a route point's announcement settings.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointModifyAnnouncementRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointModifyDNISAnnouncementRequest20
Abstract
no
Documentation
Modify a route point DNIS announcement settings.
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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointModifyDNISAnnouncementRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
dnisKey "
type ="
DNISKey
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointModifyDNISParametersRequest
Abstract
no
Documentation
Modify the setting that are configured for all the DNIS in a Route Point.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<displayDNISNumber>
xs :boolean </displayDNISNumber>
[0..1]
<displayDNISName>
xs :boolean </displayDNISName>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointModifyDNISParametersRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
displayDNISNumber "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
displayDNISName "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointModifyDNISRequest
Abstract
no
Documentation
Modify a route point's DNIS settings.
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. -->
<newDNISName>
DNISName
</newDNISName>
[0..1]
<dnisPhoneNumber>
DN
</dnisPhoneNumber>
[0..1]
<useCustomCLIDSettings>
xs :boolean </useCustomCLIDSettings>
[0..1]
<callingLineIdPhoneNumber>
DN
</callingLineIdPhoneNumber>
[0..1]
<useCustomDnisAnnouncementSettings>
xs :boolean </useCustomDnisAnnouncementSettings>
[0..1]
<allowOutgoingACDCall>
xs :boolean </allowOutgoingACDCall>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointModifyDNISRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
dnisKey "
type ="
DNISKey
"/>
<
xs:element name ="
newDNISName "
type ="
DNISName
"
minOccurs ="
0 "/>
<
xs:element name ="
dnisPhoneNumber "
type ="
DN
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
extension "
type ="
Extension17
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
useCustomCLIDSettings "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
callingLineIdPhoneNumber "
type ="
DN
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
useCustomDnisAnnouncementSettings "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
allowOutgoingACDCall "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointModifyFailoverPolicyRequest
Abstract
no
Documentation
Modify the route point failover policy.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<enableFailoverSupport>
xs :boolean </enableFailoverSupport>
[0..1]
<perCallEnableFailoverSupport>
xs :boolean </perCallEnableFailoverSupport>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointModifyFailoverPolicyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
enableFailoverSupport "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
failoverPhoneNumber "
type ="
OutgoingDNorSIPURI
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
perCallEnableFailoverSupport "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
perCallFailoverPhoneNumber "
type ="
OutgoingDNorSIPURI
"
minOccurs ="
0 "
nillable ="
true "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointModifyInstanceRequest
Abstract
no
Documentation
Request to modify a Route Point instance.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<externalPreferredAudioCodec>
AudioFileCodec
</externalPreferredAudioCodec>
[0..1]
<internalPreferredAudioCodec>
AudioFileCodec
</internalPreferredAudioCodec>
[0..1]
<enableVideo>
xs :boolean </enableVideo>
[0..1]
<playRingingWhenOfferingCall>
xs :boolean </playRingingWhenOfferingCall>
[0..1]
<overrideAgentWrapUpTime>
xs :boolean </overrideAgentWrapUpTime>
[0..1]
<enableAutomaticStateChangeForAgents>
xs :boolean </enableAutomaticStateChangeForAgents>
[0..1]
<forceDeliveryOfCalls>
xs :boolean </forceDeliveryOfCalls>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointModifyInstanceRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
externalPreferredAudioCodec "
type ="
AudioFileCodec
"
minOccurs ="
0 "/>
<
xs:element name ="
internalPreferredAudioCodec "
type ="
AudioFileCodec
"
minOccurs ="
0 "/>
<
xs:element name ="
enableVideo "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
playRingingWhenOfferingCall "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
overrideAgentWrapUpTime "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
enableAutomaticStateChangeForAgents "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
forceDeliveryOfCalls "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointNightServiceGetRequest20
Abstract
no
Documentation
Get a route point's night service settings.
The response is either a GroupRoutePointNightServiceGetResponse20 or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointNightServiceGetRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointNightServiceGetResponse20
Abstract
no
Documentation
Response to the GroupRoutePointNightServiceGetRequest20.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<forceNightService>
xs :boolean </forceNightService>
[1]
<playAnnouncementBeforeAction>
xs :boolean </playAnnouncementBeforeAction>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointNightServiceGetResponse20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
businessHours "
type ="
TimeSchedule
"
minOccurs ="
0 "/>
<
xs:element name ="
forceNightService "
type ="
xs :boolean
"/>
<
xs:element name ="
playAnnouncementBeforeAction "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointNightServiceModifyRequest20
Abstract
no
Documentation
Modify a route point's night service settings.
Only Group and Enterprise level schedules are accepted.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<forceNightService>
xs :boolean </forceNightService>
[0..1]
<playAnnouncementBeforeAction>
xs :boolean </playAnnouncementBeforeAction>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointNightServiceModifyRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
businessHours "
type ="
TimeSchedule
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
forceNightService "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
transferPhoneNumber "
type ="
OutgoingDNorSIPURI
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
playAnnouncementBeforeAction "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointOverflowGetRequest20
Abstract
no
Documentation
Get a route point's overflow settings.
The response is either a GroupRoutePointOverflowGetResponse20 or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointOverflowGetRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointOverflowGetResponse20
Abstract
no
Documentation
Response to the GroupRoutePointOverflowGetRequest20.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<overflowAfterTimeout>
xs :boolean </overflowAfterTimeout>
[1]
<playAnnouncementBeforeOverflowProcessing>
xs :boolean </playAnnouncementBeforeOverflowProcessing>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointOverflowGetResponse20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
overflowAfterTimeout "
type ="
xs :boolean
"/>
<
xs:element name ="
playAnnouncementBeforeOverflowProcessing "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointOverflowModifyRequest20
Abstract
no
Documentation
Modify a route point's overflow settings.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<overflowAfterTimeout>
xs :boolean </overflowAfterTimeout>
[0..1]
<playAnnouncementBeforeOverflowProcessing>
xs :boolean </playAnnouncementBeforeOverflowProcessing>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointOverflowModifyRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
transferPhoneNumber "
type ="
OutgoingDNorSIPURI
"
minOccurs ="
0 "
nillable ="
true "/>
<
xs:element name ="
overflowAfterTimeout "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
playAnnouncementBeforeOverflowProcessing "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointQueueCallDispositionCodeAddRequest
Abstract
no
Documentation
Add a Route Point Call Disposition Code.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<isActive>
xs :boolean </isActive>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointQueueCallDispositionCodeAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
isActive "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointQueueCallDispositionCodeDeleteRequest
Abstract
no
Documentation
Delete a Route Point Call Disposition Code.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointQueueCallDispositionCodeDeleteRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointQueueCallDispositionCodeGetListRequest
Abstract
no
Documentation
Get the list of Route Point Level and Organization Level Call Disposition Codes.
The response is either GroupRoutePointQueueCallDispositionCodeGetListResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointQueueCallDispositionCodeGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointQueueCallDispositionCodeGetListResponse
Abstract
no
Documentation
Response to the GroupRoutePointQueueCallDispositionCodeGetListRequest.
Contains a table with column headings: "Is Active", "Code", "Description" and "Level".
Level column can be any of the values in the data type CallDispositionCodeLevel.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<dispositionCodesTable>
core :OCITable
</dispositionCodesTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointQueueCallDispositionCodeGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointQueueCallDispositionCodeGetRequest
Abstract
no
Documentation
Get a Route Point Call Disposition Code.
The response is either GroupRoutePointQueueCallDispositionCodeGetResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointQueueCallDispositionCodeGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIResponse
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointQueueCallDispositionCodeGetResponse
Abstract
no
Documentation
Response to the GroupRoutePointQueueCallDispositionCodeGetRequest
XML Instance Representation
<...
debugInfo="
xs :string [0..1] ? " >
<!-- '
OCICommand
' 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 ="
GroupRoutePointQueueCallDispositionCodeGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIResponse
">
<
xs:sequence >
<
xs:element name ="
isActive "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointQueueCallDispositionCodeModifyRequest
Abstract
no
Documentation
Modify a Route Point Call Disposition Code.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<isActive>
xs :boolean </isActive>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointQueueCallDispositionCodeModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
isActive "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointQueueCallDispositionCodeSettingsGetRequest
Abstract
no
Documentation
Request the queue level data associated with Route Point Call Disposition Code Settings.
The response is either an GroupRoutePointQueueCallDispositionCodeSettingsGetResponse or an
ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointQueueCallDispositionCodeSettingsGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointQueueCallDispositionCodeSettingsGetResponse
Abstract
no
Documentation
Response to GroupRoutePointQueueCallDispositionCodeSettingsGetRequest.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<enableCallDispositionCodes>
xs :boolean </enableCallDispositionCodes>
[1]
<includeOrganizationCodes>
xs :boolean </includeOrganizationCodes>
[1]
<forceUseOfCallDispositionCodes>
xs :boolean </forceUseOfCallDispositionCodes>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointQueueCallDispositionCodeSettingsGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
enableCallDispositionCodes "
type ="
xs :boolean
"/>
<
xs:element name ="
includeOrganizationCodes "
type ="
xs :boolean
"/>
<
xs:element name ="
forceUseOfCallDispositionCodes "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointQueueCallDispositionCodeSettingsModifyRequest
Abstract
no
Documentation
Modify the queue level data associated with Route Point Agents Unavailable Code Settings.
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. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
<enableCallDispositionCodes>
xs :boolean </enableCallDispositionCodes>
[0..1]
<includeOrganizationCodes>
xs :boolean </includeOrganizationCodes>
[0..1]
<forceUseOfCallDispositionCodes>
xs :boolean </forceUseOfCallDispositionCodes>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointQueueCallDispositionCodeSettingsModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
<
xs:element name ="
enableCallDispositionCodes "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
includeOrganizationCodes "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
forceUseOfCallDispositionCodes "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
UserRoutePointCallDispositionCodeGetAvailableListRequest
Abstract
no
Documentation
Get the list of available Route Point Call Disposition Codes to be used by a client.
The response is either UserRoutePointCallDispositionCodeGetAvailableListResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId>
UserId
</serviceUserId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
UserRoutePointCallDispositionCodeGetAvailableListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
serviceUserId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
UserRoutePointCallDispositionCodeGetAvailableListResponse
Abstract
no
Documentation
Response to the UserRoutePointCallDispositionCodeGetAvailableListRequest.
This list may include Group/Enterprise level codes in addition to the Route Point level codes,
depending on the call center disposition codes settings.
Only active codes are included in the list.
Contains a table with column headings: "Code", "Description" and "Level".
Level column can be any of the values in the data type CallDispositionCodeLevel.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<dispositionCodesTable>
core :OCITable
</dispositionCodesTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
UserRoutePointCallDispositionCodeGetAvailableListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
UserRoutePointSupervisorGetListRequest
Abstract
no
Documentation
Get a list of Route Point supervisors assigned to a user.
The response is either a
UserRoutePointSupervisorGetListResponse 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
UserRoutePointSupervisorGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
userId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
UserRoutePointSupervisorGetListResponse
Abstract
no
Documentation
Response to the UserRoutePointSupervisorGetListRequest.
Contains a table with column headings: "User Id", "Last Name",
"First Name", "Hiragana Last Name", "Hiragana First Name",
"Phone Number", "Extension", "Department", "Email Address",
"Location Code".
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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
UserRoutePointSupervisorGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
UserRoutePointSupervisorModifyListRequest
Abstract
no
Documentation
Request to modify the Route Point supervisor list for a user.
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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
UserRoutePointSupervisorModifyListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
userId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
xs :int (derivation method: restriction)
Sub-types:
None
Name
NoAnswerTimeoutRings
Content
Documentation
Number of rings to wait before timeout the outgoing call.
Schema Component Representation
<
xs:simpleType name ="
NoAnswerTimeoutRings ">
<
xs:restriction base ="
xs :int
">
<xs:minInclusive value ="2 "/>
<xs:maxInclusive value ="20 "/>
</
xs:restriction >
</
xs:simpleType >
Parent type:
xs :int (derivation method: restriction)
Sub-types:
None
Name
RoutePointCallFailureTimeout
Content
Documentation
The call failure timeout.
Schema Component Representation
<
xs:simpleType name ="
RoutePointCallFailureTimeout ">
<
xs:restriction base ="
xs :int
">
<xs:minInclusive value ="1 "/>
<xs:maxInclusive value ="60 "/>
</
xs:restriction >
</
xs:simpleType >
Parent type:
xs :token (derivation method: restriction)
Sub-types:
None
Name
RoutePointFailoverStatus
Content
value comes from list: {'Normal'|'Failover'}
Documentation
The Route Point failover status.
Schema Component Representation
<
xs:simpleType name ="
RoutePointFailoverStatus ">
<
xs:restriction base ="
xs :token
">
<xs:enumeration value ="Normal "/>
<xs:enumeration value ="Failover "/>
</
xs:restriction >
</
xs:simpleType >
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.
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.)
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 .