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:schema >
Parent type:
None
Sub-types:
None
Name
CustomContactDirectoryEntry
Abstract
no
Documentation
Represents either an existing user's Id or an existing Virtual
On-Net user's DN. For a DN the groupId is used to make it unique
within an Enterprise, however the groupId is not used with Service
Providers.
XML Instance Representation
<...>
Start Choice [1]
<virtualOnNetPhoneNumber>
DN
</virtualOnNetPhoneNumber>
[1]
<groupId>
GroupId
</groupId>
[0..1]
End Choice
</...>
Schema Component Representation
<
xs:complexType name ="
CustomContactDirectoryEntry ">
<
xs:sequence >
<
xs:choice >
<
xs:element name ="
userId "
type ="
UserId
"/>
<
xs:sequence >
<
xs:element name ="
virtualOnNetPhoneNumber "
type ="
DN
"/>
<
xs:element name ="
groupId "
type ="
GroupId
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:choice >
</
xs:sequence >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceAddRequest14
Abstract
no
Documentation
Request to add a group access device.
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. -->
<outboundProxyServerNetAddress>
NetAddress
</outboundProxyServerNetAddress>
[0..1]
<stunServerNetAddress>
NetAddress
</stunServerNetAddress>
[0..1]
<mobilityManagerProvisioningURL>
URL
</mobilityManagerProvisioningURL>
[0..1]
<mobilityManagerDefaultOriginatingServiceKey>
MobilityManagerServiceKey
</mobilityManagerDefaultOriginatingServiceKey>
[0..1]
<mobilityManagerDefaultTerminatingServiceKey>
MobilityManagerServiceKey
</mobilityManagerDefaultTerminatingServiceKey>
[0..1]
<useCustomUserNamePassword>
xs :boolean </useCustomUserNamePassword>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceAddRequest14 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
netAddress "
type ="
NetAddress
"
minOccurs ="
0 "/>
<
xs:element name ="
port "
type ="
Port1025
"
minOccurs ="
0 "/>
<
xs:element name ="
outboundProxyServerNetAddress "
type ="
NetAddress
"
minOccurs ="
0 "/>
<
xs:element name ="
stunServerNetAddress "
type ="
NetAddress
"
minOccurs ="
0 "/>
<
xs:element name ="
mobilityManagerProvisioningURL "
type ="
URL
"
minOccurs ="
0 "/>
<
xs:element name ="
useCustomUserNamePassword "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceAvailablePortGetListRequest
Abstract
no
Documentation
Request to get the list of available ports in a device.
The response is either GroupAccessDeviceAvailablePortGetListResponse 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 ="
GroupAccessDeviceAvailablePortGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceAvailablePortGetListResponse
Abstract
no
Documentation
Response to GroupAccessDeviceAvailablePortGetListRequest.
Contains a list of available ports in a device using static mode. The list is empty in case the device is using dynamic mode.
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 ="
GroupAccessDeviceAvailablePortGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceCustomTagAddRequest
Abstract
no
Documentation
Request to add a static configuration tag for a group access device.
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 ="
GroupAccessDeviceCustomTagAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceCustomTagDeleteListRequest
Abstract
no
Documentation
Request to delete static configuration tags for a group access device.
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 ="
GroupAccessDeviceCustomTagDeleteListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceCustomTagGetListRequest
Abstract
no
Documentation
Request to get the list of custom configuration tags managed by the Device Management System, on a per-device profile basis.
The response is either GroupAccessDeviceCustomTagGetListResponse 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 ="
GroupAccessDeviceCustomTagGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceCustomTagGetListResponse
Abstract
no
Documentation
Response to GroupAccessDeviceCustomTagGetListRequest.
Contains a table of custom configuration tags managed by the Device Management System on a per-device profile basis.
The column headings are: "Tag Name", "Tag Value"
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<deviceCustomTagsTable>
core :OCITable
</deviceCustomTagsTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceCustomTagGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceCustomTagModifyRequest
Abstract
no
Documentation
Request to modify a static configuration tag for a group access device.
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 ="
GroupAccessDeviceCustomTagModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceDeleteRequest
Abstract
no
Documentation
Request to delete a specified group access device.
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 ="
GroupAccessDeviceDeleteRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceFileGetListRequest14sp8
Abstract
no
Documentation
Request to get the list of device files managed by the Device Management System, on a per-device profile basis.
The response is either GroupAccessDeviceFileGetListResponse14sp8 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 ="
GroupAccessDeviceFileGetListRequest14sp8 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceFileGetListResponse14sp8
Abstract
no
Documentation
Response to GroupAccessDeviceFileGetListRequest14sp8.
Contains a table of device files managed by the Device Management System on a per-device profile basis.
The column headings are: "File Format", "Is Authenticated", "Access URL", "Repository URL", "Template URL", "Extended Capture".
The following columns are only used in AS data mode:
"Extended Capture"
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 ="
GroupAccessDeviceFileGetListResponse14sp8 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceFileGetRequest20
Abstract
no
Documentation
Request to get a group device profile file.
The response is either GroupAccessDeviceFileGetResponse20 or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceFileGetRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceFileGetResponse20
Abstract
no
Documentation
Response to GroupAccessDeviceFileGetRequest20.
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. -->
<accessUrl>
URL
</accessUrl>
[1]
<repositoryUrl>
URL
</repositoryUrl>
[0..1]
<templateUrl>
URL
</templateUrl>
[0..1]
<extendedCaptureEnabled>
xs :boolean </extendedCaptureEnabled>
[0..1]
<extendedCaptureURL>
URL
</extendedCaptureURL>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceFileGetResponse20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
accessUrl "
type ="
URL
"/>
<
xs:element name ="
repositoryUrl "
type ="
URL
"
minOccurs ="
0 "/>
<
xs:element name ="
templateUrl "
type ="
URL
"
minOccurs ="
0 "/>
<
xs:element name ="
extendedCaptureEnabled "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
extendedCaptureURL "
type ="
URL
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceFileModifyRequest14sp8
Abstract
no
Documentation
Request to modify a specified group access device file.
The response is either a SuccessResponse or an ErrorResponse.
The following elements are only used in AS data mode:
extendedCaptureEnabled
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<extendedCaptureEnabled>
xs :boolean </extendedCaptureEnabled>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceFileModifyRequest14sp8 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
uploadFile "
type ="
FileResource
"
minOccurs ="
0 "/>
<
xs:element name ="
extendedCaptureEnabled "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceGetAvailableDetailListRequest19
Abstract
no
Documentation
Requests the list of available access devices for assignment to a user
within a group. The list includes devices created at the system, service provider, and group levels.
The response is either GroupAccessDeviceGetAvailableDetailListResponse19 or
ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<isMusicOnHold>
xs :boolean </isMusicOnHold>
[1]
<onlyVideoCapable>
xs :boolean </onlyVideoCapable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceGetAvailableDetailListRequest19 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
isMusicOnHold "
type ="
xs :boolean
"/>
<
xs:element name ="
onlyVideoCapable "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceGetAvailableDetailListResponse19
Abstract
no
Documentation
Response to GroupAccessDeviceGetAvailableDetailListRequest19.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<availableAccessDevice>
[0..*]
<staticRegistrationCapable>
xs :boolean </staticRegistrationCapable>
[1]
<useDomain>
xs :boolean </useDomain>
[1]
<staticLineOrdering>
xs :boolean </staticLineOrdering>
[1]
</availableAccessDevice>
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceGetAvailableDetailListResponse19 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
availableAccessDevice "
minOccurs ="
0 "
maxOccurs ="
unbounded ">
<
xs:complexType >
<
xs:sequence >
<
xs:element name ="
staticRegistrationCapable "
type ="
xs :boolean
"/>
<
xs:element name ="
useDomain "
type ="
xs :boolean
"/>
<
xs:element name ="
staticLineOrdering "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:complexType >
</
xs:element >
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceGetEnhancedConfigurationTypeListRequest
Abstract
no
Documentation
Requests the list of configurable device types of devices that have already been
added to the group.
The response is either GroupAccessDeviceGetEnhancedConfigurationTypeListResponse
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 ="
GroupAccessDeviceGetEnhancedConfigurationTypeListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceGetEnhancedConfigurationTypeListResponse
Abstract
no
Documentation
Response to GroupAccessDeviceGetEnhancedConfigurationTypeListRequest.
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 ="
GroupAccessDeviceGetEnhancedConfigurationTypeListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
deviceType "
type ="
AccessDeviceType
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceGetEnhancedConfigurationTypeRequest14
Abstract
no
Documentation
Requests the details of a specified configurable device type for a group.
The response is either GroupAccessDeviceGetEnhancedConfigurationTypeResponse14
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 ="
GroupAccessDeviceGetEnhancedConfigurationTypeRequest14 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceGetEnhancedConfigurationTypeResponse14
Abstract
no
Documentation
Response to GroupAccessDeviceGetEnhancedConfigurationTypeRequest14.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<supportsEnhancedConfiguration>
xs :boolean </supportsEnhancedConfiguration>
[1]
<supportsReset>
xs :boolean </supportsReset>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceGetEnhancedConfigurationTypeResponse14 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
supportsEnhancedConfiguration "
type ="
xs :boolean
"/>
<
xs:element name ="
supportsReset "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceGetListRequest
Abstract
no
Documentation
Requests the list of access devices in a group.
The response is either GroupAccessDeviceGetListResponse 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 ="
GroupAccessDeviceGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceGetListResponse
Abstract
no
Documentation
Response to GroupAccessDeviceGetListRequest.
Contains a table of devices configured in the group.
The column headings are: "Device Name", "Device Type", "Available Ports", "Net Address", "MAC Address", "Status" and "Version".
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 ="
GroupAccessDeviceGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceGetRequest18sp1
Abstract
no
Documentation
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetResponse18sp1 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 ="
GroupAccessDeviceGetRequest18sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceGetResponse18sp1
Abstract
no
Documentation
Response to GroupAccessDeviceGetRequest18sp1.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<outboundProxyServerNetAddress>
NetAddress
</outboundProxyServerNetAddress>
[0..1]
<stunServerNetAddress>
NetAddress
</stunServerNetAddress>
[0..1]
<numberOfAssignedPorts>
xs :int </numberOfAssignedPorts>
[1]
<mobilityManagerProvisioningURL>
URL
</mobilityManagerProvisioningURL>
[0..1]
<mobilityManagerDefaultOriginatingServiceKey>
MobilityManagerServiceKey
</mobilityManagerDefaultOriginatingServiceKey>
[0..1]
<mobilityManagerDefaultTerminatingServiceKey>
MobilityManagerServiceKey
</mobilityManagerDefaultTerminatingServiceKey>
[0..1]
<useCustomUserNamePassword>
xs :boolean </useCustomUserNamePassword>
[0..1]
<userName>
UserId
</userName>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceGetResponse18sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
netAddress "
type ="
NetAddress
"
minOccurs ="
0 "/>
<
xs:element name ="
port "
type ="
Port1025
"
minOccurs ="
0 "/>
<
xs:element name ="
outboundProxyServerNetAddress "
type ="
NetAddress
"
minOccurs ="
0 "/>
<
xs:element name ="
stunServerNetAddress "
type ="
NetAddress
"
minOccurs ="
0 "/>
<
xs:element name ="
numberOfAssignedPorts "
type ="
xs :int
"/>
<
xs:element name ="
mobilityManagerProvisioningURL "
type ="
URL
"
minOccurs ="
0 "/>
<
xs:element name ="
useCustomUserNamePassword "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
userName "
type ="
UserId
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceGetUserListRequest
Abstract
no
Documentation
Requests the configuration of a specified group access device.
The response is either GroupAccessDeviceGetUserListResponse 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 ="
GroupAccessDeviceGetUserListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
searchCriteriaDn "
type ="
SearchCriteriaDn
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaUserId "
type ="
SearchCriteriaUserId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAccessDeviceGetUserListResponse
Abstract
no
Documentation
Response to GroupAccessDeviceGetUserListRequest.
The column headings for the deviceUserTable are: "Line/Port", "Last Name",
"First Name", "Phone Number", "User Id", "User Type", "Endpoint Type", "Order", "Primary Line/Port", "Extension", "Department", "Email Address".
In IMS mode, the table will contain a row for each TEL-URI in the Phone Number column.
In Standalone mode, rows for the alternate numbers are not included.
The User Type column contains one of the enumerated UserType values.
The Endpoint Type column contains one of the enumerated EndpointType values.
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 ="
GroupAccessDeviceGetUserListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceModifyRequest14
Abstract
no
Documentation
Request to modify a specified group access device.
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. -->
<outboundProxyServerNetAddress>
NetAddress
</outboundProxyServerNetAddress>
[0..1]
<stunServerNetAddress>
NetAddress
</stunServerNetAddress>
[0..1]
<configurationFile>
FileResource
</configurationFile>
[0..1]
<mobilityManagerProvisioningURL>
URL
</mobilityManagerProvisioningURL>
[0..1]
<mobilityManagerDefaultOriginatingServiceKey>
MobilityManagerServiceKey
</mobilityManagerDefaultOriginatingServiceKey>
[0..1]
<mobilityManagerDefaultTerminatingServiceKey>
MobilityManagerServiceKey
</mobilityManagerDefaultTerminatingServiceKey>
[0..1]
<useCustomUserNamePassword>
xs :boolean </useCustomUserNamePassword>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceModifyRequest14 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
netAddress "
type ="
NetAddress
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
port "
type ="
Port1025
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
outboundProxyServerNetAddress "
type ="
NetAddress
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
stunServerNetAddress "
type ="
NetAddress
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
configurationFile "
type ="
FileResource
"
minOccurs ="
0 "/>
<
xs:element name ="
mobilityManagerProvisioningURL "
type ="
URL
"
minOccurs ="
0 "/>
<
xs:element name ="
mobilityManagerDefaultOriginatingServiceKey "
type ="
MobilityManagerServiceKey
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
mobilityManagerDefaultTerminatingServiceKey "
type ="
MobilityManagerServiceKey
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
useCustomUserNamePassword "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceModifyUserRequest
Abstract
no
Documentation
Request to modify attributes for line/ports assigned on the group device profile.
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. -->
<isPrimaryLinePort>
xs :boolean </isPrimaryLinePort>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAccessDeviceModifyUserRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
isPrimaryLinePort "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAccessDeviceResetRequest
Abstract
no
Documentation
Reset a specific group SIP device that supports the reset operation.
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 ="
GroupAccessDeviceResetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAddRequest
Abstract
no
Documentation
Add a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<contact>
Contact
</contact>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
defaultDomain "
type ="
NetAddress
"/>
<
xs:element name ="
groupName "
type ="
GroupName
"
minOccurs ="
0 "/>
<
xs:element name ="
timeZone "
type ="
TimeZone
"
minOccurs ="
0 "/>
<
xs:element name ="
contact "
type ="
Contact
"
minOccurs ="
0 "/>
<
xs:element name ="
address "
type ="
StreetAddress
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAdminAddRequest
Abstract
no
Documentation
Add a group administrator.
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 ="
GroupAdminAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
userId "
type ="
UserId
"/>
<
xs:element name ="
firstName "
type ="
FirstName
"
minOccurs ="
0 "/>
<
xs:element name ="
lastName "
type ="
LastName
"
minOccurs ="
0 "/>
<
xs:element name ="
password "
type ="
Password
"
minOccurs ="
0 "/>
<
xs:element name ="
language "
type ="
Language
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAdminDeleteRequest
Abstract
no
Documentation
Delete a group administrator.
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 ="
GroupAdminDeleteRequest ">
<
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:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAdminGetListRequest
Abstract
no
Documentation
Get a list of group and department administrators within the group.
The response is either a GroupAdminGetListResponse 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 ="
GroupAdminGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAdminGetListResponse
Abstract
no
Documentation
Response to GroupAdminGetListRequest.
Contains a 5 column table with column headings "Administrator ID",
"Last Name", "First Name", "Department", "Language".
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 ="
GroupAdminGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAdminGetPolicyRequest20
Abstract
no
Documentation
Requests the Group administrator's policy settings.
The response is either GroupAdminGetPolicyResponse20 or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> true
</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 ="
GroupAdminGetPolicyRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
userId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAdminGetPolicyResponse20
Abstract
no
Documentation
Response to GroupAdminGetPolicyRequest20.
Contains the policy settings for the group administrator.
The following elements are only used in AS data mode:
dialableCallerIDAccess
verifyTranslationAndroutingAccess
communicationBarringUserProfileAccess (This element is only returned for groups in an enterprise)
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> true
</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 ="
GroupAdminGetPolicyResponse20 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAdminGetRequest
Abstract
no
Documentation
Get a group administrators profile.
The response is either a GroupAdminGetResponse 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 ="
GroupAdminGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
userId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAdminGetResponse
Abstract
no
Documentation
Response to the GroupAdminGetRequest.
The response contains the group administrators profile information.
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 ="
GroupAdminGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
firstName "
type ="
FirstName
"
minOccurs ="
0 "/>
<
xs:element name ="
lastName "
type ="
LastName
"
minOccurs ="
0 "/>
<
xs:element name ="
language "
type ="
Language
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAdminModifyPolicyRequest
Abstract
no
Documentation
Request to modify the group administrator's policy settings.
The response is either SuccessResponse or ErrorResponse.
The following elements are only used in AS data mode:
dialableCallerIDAccess
verifyTranslationAndRoutingAccess
communicationBarringUserProfileAccess (only applicable to groups in an Enterprise)
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> true
</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 ="
GroupAdminModifyPolicyRequest ">
<
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:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAdminModifyRequest
Abstract
no
Documentation
Modify a group administrator.
Since old password is not specified here, any password rule related to old password
does not apply.
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 ="
GroupAdminModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
userId "
type ="
UserId
"/>
<
xs:element name ="
firstName "
type ="
FirstName
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
lastName "
type ="
LastName
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
password "
type ="
Password
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
language "
type ="
Language
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAnnouncementFileAddRequest
Abstract
no
Documentation
Add an announcement to the group announcement repository
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 ="
GroupAnnouncementFileAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAnnouncementFileDeleteListRequest
Abstract
no
Documentation
Delete one or more announcements from the group announcement repository
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 ="
GroupAnnouncementFileDeleteListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAnnouncementFileGetListRequest
Abstract
no
Documentation
Get the list of available announcement files for a Group.
The response is either a GroupAnnouncementFileGetListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<includeAnnouncementTable>
xs :boolean </includeAnnouncementTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAnnouncementFileGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
includeAnnouncementTable "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAnnouncementFileGetListResponse
Abstract
no
Documentation
Response to GroupAnnouncementFileGetAvailableListRequest.
When requested, the response contains a table with columns: "Name", "Media Type" and "File Size".
The "Name" column contains the name of the announcement file.
The "Media Type" column contains the media type of the announcement
File with the possible values:
WMA - Windows Media Audio file
WAV - A WAV file
3GP - A 3GP file
MOV - A MOV file using a H.263 or H.264 codec.
The "File Size" column contains the file size (KB) of the announcement file.
The response also contains the current total file size (KB) for the group across
all media types and the maximum total file size (MB) allowed for the group.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<announcementTable>
core :OCITable
</announcementTable>
[0..1]
<totalFileSize>
xs :int </totalFileSize>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAnnouncementFileGetListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
announcementTable "
type ="
core :OCITable
"
minOccurs ="
0 "/>
<
xs:element name ="
totalFileSize "
type ="
xs :int
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAnnouncementFileGetRequest
Abstract
no
Documentation
Request to get the announcement repository file information.
The response is either GroupAnnouncementFileGetResponse 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 ="
GroupAnnouncementFileGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupAnnouncementFileGetResponse
Abstract
no
Documentation
Response to GroupAnnouncementFileGetRequest.
The response contains the file size, uploaded timestamp, description and usage for
an announcement file in the user announcement repository.
The usage table has columns "Service Name", and "Instance Name".
The Service Name values correspond to string values of the GroupService and UserService data types.
With the exception of the string "Voice Portal" which is returned when the announcement is being used by Voice Portal Personalized Name.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<filesize>
xs :int </filesize>
[1]
<lastUploaded>
xs :dateTime </lastUploaded>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupAnnouncementFileGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
filesize "
type ="
xs :int
"/>
<
xs:element name ="
lastUploaded "
type ="
xs :dateTime
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupAnnouncementFileModifyRequest
Abstract
no
Documentation
Modify an existing announcement in the group repository
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 ="
GroupAnnouncementFileModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupApplicationServerSetGetRequest
Abstract
no
Documentation
Get the Application Server set for a group.
The response is either a GroupApplicationServerSetGetResponse 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 ="
GroupApplicationServerSetGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupApplicationServerSetGetResponse
Abstract
no
Documentation
Response to the GroupApplicationServerSetGetRequest.
The response contains the group's Application Server set information.
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 ="
GroupApplicationServerSetGetResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupApplicationServerSetModifyRequest
Abstract
no
Documentation
Modify the Application Server set for a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupApplicationServerSetModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerActivationRequest
Abstract
no
Documentation
Activates or Deactivates the BroadWorks Mobile Manager.
The deactivationReason is required when isActive is set to false.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<isActive>
xs :boolean </isActive>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerActivationRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
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
GroupBroadWorksMobileManagerAddHomeZoneRequest
Abstract
no
Documentation
Add a home zone to the BroadWorks Mobile Manager.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerAddHomeZoneRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerAddRequest
Abstract
no
Documentation
Add the BroadWorks Mobile Manager.
Only one BroadWorks Mobile Manager can be added per group.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<isActive>
xs :boolean </isActive>
[1]
<localToCarrier>
xs :boolean </localToCarrier>
[1]
<maxTxPerSecondEnabled>
xs :boolean </maxTxPerSecondEnabled>
[1]
<tldnEnabled>
xs :boolean </tldnEnabled>
[1]
<genericNumberEnabled>
xs :boolean </genericNumberEnabled>
[1]
<mobileStateCheckEnabled>
xs :boolean </mobileStateCheckEnabled>
[1]
<locationBasedServicesEnabled>
xs :boolean </locationBasedServicesEnabled>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
isActive "
type ="
xs :boolean
"/>
<
xs:element name ="
localToCarrier "
type ="
xs :boolean
"/>
<
xs:element name ="
maxTxPerSecondEnabled "
type ="
xs :boolean
"/>
<
xs:element name ="
tldnEnabled "
type ="
xs :boolean
"/>
<
xs:element name ="
genericNumberEnabled "
type ="
xs :boolean
"/>
<
xs:element name ="
mobileStateCheckEnabled "
type ="
xs :boolean
"/>
<
xs:element name ="
locationBasedServicesEnabled "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerDeleteHomeZoneListRequest
Abstract
no
Documentation
Delete a list of home zones from the BroadWorks Mobile Manager.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<homeZoneId>
xs :string </homeZoneId>
[1..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerDeleteHomeZoneListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
homeZoneId "
type ="
xs :string
"
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerDeleteHomeZoneRequest
Abstract
no
Documentation
Delete a home zone from the BroadWorks Mobile Manager.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<homeZoneId>
xs :string </homeZoneId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerDeleteHomeZoneRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
homeZoneId "
type ="
xs :string
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerDeleteRequest
Abstract
no
Documentation
Delete the BroadWorks Mobile Manager.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerDeleteRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerGetDomainListRequest
Abstract
no
Documentation
Get the list of domains of the BroadWorks Mobile Manager.
The response is either GroupBroadWorksMobileManagerGetDomainListResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerGetDomainListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupBroadWorksMobileManagerGetDomainListResponse
Abstract
no
Documentation
Response to the GroupBroadWorksMobileManagerGetDomainListRequest.
Contains the list of domains.
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 ="
GroupBroadWorksMobileManagerGetDomainListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerGetHomeZoneListRequest
Abstract
no
Documentation
Get the list of home zones of the BroadWorks Mobile Manager.
The response is either GroupBroadWorksMobileManagerGetHomeZoneListResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerGetHomeZoneListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupBroadWorksMobileManagerGetHomeZoneListResponse
Abstract
no
Documentation
Response to the GroupBroadWorksMobileManagerGetHomeZoneListRequest.
Contains a table with column headings:
"Home Zone Id", "Domain Name", "Mobile Country Code",
"Mobile Network Code", "Local Area Code" and "Cell Identity".
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 ="
GroupBroadWorksMobileManagerGetHomeZoneListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerGetHomeZoneRequest
Abstract
no
Documentation
Get a home zone from the BroadWorks Mobile Manager.
The response is either GroupBroadWorksMobileManagerGetHomeZoneResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<homeZoneId>
xs :string </homeZoneId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerGetHomeZoneRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
homeZoneId "
type ="
xs :string
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupBroadWorksMobileManagerGetHomeZoneResponse
Abstract
no
Documentation
Response to the GroupBroadWorksMobileManagerGetHomeZoneRequest
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 ="
GroupBroadWorksMobileManagerGetHomeZoneResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerGetRequest
Abstract
no
Documentation
Get the BroadWorks Mobile Manager.
The response is either GroupBroadWorksMobileManagerGetResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupBroadWorksMobileManagerGetResponse
Abstract
no
Documentation
Response to the GroupBroadWorksMobileManagerGetRequest
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. -->
<isActive>
xs :boolean </isActive>
[1]
<localToCarrier>
xs :boolean </localToCarrier>
[1]
<maxTxPerSecondEnabled>
xs :boolean </maxTxPerSecondEnabled>
[1]
<tldnEnabled>
xs :boolean </tldnEnabled>
[1]
<genericNumberEnabled>
xs :boolean </genericNumberEnabled>
[1]
<mobileStateCheckEnabled>
xs :boolean </mobileStateCheckEnabled>
[1]
<locationBasedServicesEnabled>
xs :boolean </locationBasedServicesEnabled>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
isActive "
type ="
xs :boolean
"/>
<
xs:element name ="
localToCarrier "
type ="
xs :boolean
"/>
<
xs:element name ="
maxTxPerSecondEnabled "
type ="
xs :boolean
"/>
<
xs:element name ="
tldnEnabled "
type ="
xs :boolean
"/>
<
xs:element name ="
genericNumberEnabled "
type ="
xs :boolean
"/>
<
xs:element name ="
mobileStateCheckEnabled "
type ="
xs :boolean
"/>
<
xs:element name ="
locationBasedServicesEnabled "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerModifyHomeZoneRequest
Abstract
no
Documentation
Modify an existing home zone in the BroadWorks Mobile Manager.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<homeZoneId>
xs :string </homeZoneId>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerModifyHomeZoneRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
homeZoneId "
type ="
xs :string
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerModifyRequest
Abstract
no
Documentation
Modify the BroadWorks Mobile Manager settings.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<localToCarrier>
xs :boolean </localToCarrier>
[0..1]
<maxTxPerSecondEnabled>
xs :boolean </maxTxPerSecondEnabled>
[0..1]
<tldnEnabled>
xs :boolean </tldnEnabled>
[0..1]
<genericNumberEnabled>
xs :boolean </genericNumberEnabled>
[0..1]
<mobileStateCheckEnabled>
xs :boolean </mobileStateCheckEnabled>
[0..1]
<locationBasedServicesEnabled>
xs :boolean </locationBasedServicesEnabled>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
localToCarrier "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
maxTxPerSecondEnabled "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
tldnEnabled "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
genericNumberEnabled "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
mobileStateCheckEnabled "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
locationBasedServicesEnabled "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupBroadWorksMobileManagerSendCarrierFilesRequest
Abstract
no
Documentation
Sends an email with the carrier information and certificate files.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupBroadWorksMobileManagerSendCarrierFilesRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCallProcessingGetPolicyRequest19sp1
Abstract
no
Documentation
Request the group level data associated with Call Processing Policy.
The response is either a GroupCallProcessingGetPolicyResponse19sp1 or an
ErrorResponse.
The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowDepartmentCLIDNameOverride)
The useGroupMediaSetting attribute controls the Media settings
(medisPolicySelection, supportedMediaSetName)
The useGroupCallLimitsSetting attribute controls the Call Limits settings
(useMaxSimultaneousCalls, maxSimultaneousCalls,
useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations)
The useGroupTranslationRoutingSetting attribute controls the routing and translation settings
(networkUsageSelection, enforceGroupCallingLineIdentityRestriction,
allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing)
The following elements are only used in AS data mode:
useGroupDCLIDSetting
enableDialableCallerID
allowDepartmentCLIDNameOverride
enterpriseCallsCLIDPolicy
groupCallsCLIDPolicy
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> true
</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 ="
GroupCallProcessingGetPolicyRequest19sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupCallProcessingGetPolicyResponse19sp1
Abstract
no
Documentation
Response to GroupCallProcessingGetPolicyRequest.
The following elements are only used in AS data mode:
useGroupDCLIDSetting
enableDialableCallerID
allowConfigurableCLIDForRedirectingIdentity
allowDepartmentCLIDNameOverride
enterpriseCallsCLIDPolicy
groupCallsCLIDPolicy
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> true
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<useGroupCLIDSetting>
xs :boolean </useGroupCLIDSetting>
[1]
<useGroupMediaSetting>
xs :boolean </useGroupMediaSetting>
[1]
<useGroupCallLimitsSetting>
xs :boolean </useGroupCallLimitsSetting>
[1]
<useGroupTranslationRoutingSetting>
xs :boolean </useGroupTranslationRoutingSetting>
[1]
<useGroupDCLIDSetting>
xs :boolean </useGroupDCLIDSetting>
[1]
<useMaxSimultaneousCalls>
xs :boolean </useMaxSimultaneousCalls>
[1]
<useMaxSimultaneousVideoCalls>
xs :boolean </useMaxSimultaneousVideoCalls>
[1]
<useMaxCallTimeForAnsweredCalls>
xs :boolean </useMaxCallTimeForAnsweredCalls>
[1]
<useMaxCallTimeForUnansweredCalls>
xs :boolean </useMaxCallTimeForUnansweredCalls>
[1]
<supportedMediaSetName>
MediaSetName
</supportedMediaSetName>
[0..1]
<enforceGroupCallingLineIdentityRestriction>
xs :boolean </enforceGroupCallingLineIdentityRestriction>
[1]
<allowEnterpriseGroupCallTypingForPrivateDialingPlan>
xs :boolean </allowEnterpriseGroupCallTypingForPrivateDialingPlan>
[1]
<allowEnterpriseGroupCallTypingForPublicDialingPlan>
xs :boolean </allowEnterpriseGroupCallTypingForPublicDialingPlan>
[1]
<overrideCLIDRestrictionForPrivateCallCategory>
xs :boolean </overrideCLIDRestrictionForPrivateCallCategory>
[0..1]
<useEnterpriseCLIDForPrivateCallCategory>
xs :boolean </useEnterpriseCLIDForPrivateCallCategory>
[0..1]
<enableEnterpriseExtensionDialing>
xs :boolean </enableEnterpriseExtensionDialing>
[1]
<useMaxConcurrentRedirectedCalls>
xs :boolean </useMaxConcurrentRedirectedCalls>
[1]
<useMaxFindMeFollowMeDepth>
xs :boolean </useMaxFindMeFollowMeDepth>
[1]
<useMaxConcurrentFindMeFollowMeInvocations>
xs :boolean </useMaxConcurrentFindMeFollowMeInvocations>
[1]
<allowAlternateNumbersForRedirectingIdentity>
xs :boolean </allowAlternateNumbersForRedirectingIdentity>
[1]
<useGroupName>
xs :boolean </useGroupName>
[1]
<blockCallingNameForExternalCalls>
xs :boolean </blockCallingNameForExternalCalls>
[1]
<enableDialableCallerID>
xs :boolean </enableDialableCallerID>
[1]
<allowConfigurableCLIDForRedirectingIdentity>
xs :boolean </allowConfigurableCLIDForRedirectingIdentity>
[1]
<allowDepartmentCLIDNameOverride>
xs :boolean </allowDepartmentCLIDNameOverride>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCallProcessingGetPolicyResponse19sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
useGroupCLIDSetting "
type ="
xs :boolean
"/>
<
xs:element name ="
useGroupMediaSetting "
type ="
xs :boolean
"/>
<
xs:element name ="
useGroupCallLimitsSetting "
type ="
xs :boolean
"/>
<
xs:element name ="
useGroupTranslationRoutingSetting "
type ="
xs :boolean
"/>
<
xs:element name ="
useGroupDCLIDSetting "
type ="
xs :boolean
"/>
<
xs:element name ="
useMaxSimultaneousCalls "
type ="
xs :boolean
"/>
<
xs:element name ="
useMaxSimultaneousVideoCalls "
type ="
xs :boolean
"/>
<
xs:element name ="
useMaxCallTimeForAnsweredCalls "
type ="
xs :boolean
"/>
<
xs:element name ="
useMaxCallTimeForUnansweredCalls "
type ="
xs :boolean
"/>
<
xs:element name ="
supportedMediaSetName "
type ="
MediaSetName
"
minOccurs ="
0 "/>
<
xs:element name ="
enforceGroupCallingLineIdentityRestriction "
type ="
xs :boolean
"/>
<
xs:element name ="
allowEnterpriseGroupCallTypingForPrivateDialingPlan "
type ="
xs :boolean
"/>
<
xs:element name ="
allowEnterpriseGroupCallTypingForPublicDialingPlan "
type ="
xs :boolean
"/>
<
xs:element name ="
overrideCLIDRestrictionForPrivateCallCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useEnterpriseCLIDForPrivateCallCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
enableEnterpriseExtensionDialing "
type ="
xs :boolean
"/>
<
xs:element name ="
useMaxConcurrentRedirectedCalls "
type ="
xs :boolean
"/>
<
xs:element name ="
useMaxFindMeFollowMeDepth "
type ="
xs :boolean
"/>
<
xs:element name ="
useMaxConcurrentFindMeFollowMeInvocations "
type ="
xs :boolean
"/>
<
xs:element name ="
allowAlternateNumbersForRedirectingIdentity "
type ="
xs :boolean
"/>
<
xs:element name ="
useGroupName "
type ="
xs :boolean
"/>
<
xs:element name ="
blockCallingNameForExternalCalls "
type ="
xs :boolean
"/>
<
xs:element name ="
enableDialableCallerID "
type ="
xs :boolean
"/>
<
xs:element name ="
allowConfigurableCLIDForRedirectingIdentity "
type ="
xs :boolean
"/>
<
xs:element name ="
allowDepartmentCLIDNameOverride "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCallProcessingModifyPolicyRequest15sp2
Abstract
no
Documentation
Modify the group level data associated with Call Procesing Policy.
The response is either a SuccessResponse or an ErrorResponse.
The useGroupCLIDSetting attribute controls the CLID settings
(clidPolicy,enterpriseCallsCLIDPolicy, groupCallsCLIDPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride)
The allowDepartmentCLID attribute is automatically set to false when the useGroupName attribute is set to false.
The useGroupMediaSetting attribute controls the Media settings
(medisPolicySelection, supportedMediaSetName)
The useGroupCallLimitsSetting attribute controls the Call Limits settings
(useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations)
The useGroupTranslationRoutingSetting attribute controls the routing and translation settings (networkUsageSelection, enforceGroupCallingLineIdentityRestriction, allowEnterpriseGroupCallTypingForPrivateDialingPlan, allowEnterpriseGroupCallTypingForPublicDialingPlan, overrideCLIDRestrictionForExternalCallsViaPrivateDialingPlan, enableEnterpriseExtensionDialing)
The useGroupDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID)
The following elements are only used in AS data mode:
useGroupDCLIDSetting
enableDialableCallerID
allowConfigurableCLIDForRedirectingIdentity
allowDepartmentCLIDNameOverride
allowConfigurableCLIDForRedirectingIdentity
enterpriseCallsCLIDPolicy
groupCallsCLIDPolicy
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> true
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<useGroupCLIDSetting>
xs :boolean </useGroupCLIDSetting>
[0..1]
<useGroupMediaSetting>
xs :boolean </useGroupMediaSetting>
[0..1]
<useGroupCallLimitsSetting>
xs :boolean </useGroupCallLimitsSetting>
[0..1]
<useGroupTranslationRoutingSetting>
xs :boolean </useGroupTranslationRoutingSetting>
[0..1]
<useGroupDCLIDSetting>
xs :boolean </useGroupDCLIDSetting>
[0..1]
<useMaxSimultaneousCalls>
xs :boolean </useMaxSimultaneousCalls>
[0..1]
<useMaxSimultaneousVideoCalls>
xs :boolean </useMaxSimultaneousVideoCalls>
[0..1]
<useMaxCallTimeForAnsweredCalls>
xs :boolean </useMaxCallTimeForAnsweredCalls>
[0..1]
<useMaxCallTimeForUnansweredCalls>
xs :boolean </useMaxCallTimeForUnansweredCalls>
[0..1]
<supportedMediaSetName>
MediaSetName
</supportedMediaSetName>
[0..1]
<enforceGroupCallingLineIdentityRestriction>
xs :boolean </enforceGroupCallingLineIdentityRestriction>
[0..1]
<allowEnterpriseGroupCallTypingForPrivateDialingPlan>
xs :boolean </allowEnterpriseGroupCallTypingForPrivateDialingPlan>
[0..1]
<allowEnterpriseGroupCallTypingForPublicDialingPlan>
xs :boolean </allowEnterpriseGroupCallTypingForPublicDialingPlan>
[0..1]
<overrideCLIDRestrictionForPrivateCallCategory>
xs :boolean </overrideCLIDRestrictionForPrivateCallCategory>
[0..1]
<useEnterpriseCLIDForPrivateCallCategory>
xs :boolean </useEnterpriseCLIDForPrivateCallCategory>
[0..1]
<enableEnterpriseExtensionDialing>
xs :boolean </enableEnterpriseExtensionDialing>
[0..1]
<useMaxConcurrentRedirectedCalls>
xs :boolean </useMaxConcurrentRedirectedCalls>
[0..1]
<useMaxFindMeFollowMeDepth>
xs :boolean </useMaxFindMeFollowMeDepth>
[0..1]
<useMaxConcurrentFindMeFollowMeInvocations>
xs :boolean </useMaxConcurrentFindMeFollowMeInvocations>
[0..1]
<allowAlternateNumbersForRedirectingIdentity>
xs :boolean </allowAlternateNumbersForRedirectingIdentity>
[0..1]
<useGroupName>
xs :boolean </useGroupName>
[0..1]
<blockCallingNameForExternalCalls>
xs :boolean </blockCallingNameForExternalCalls>
[0..1]
<enableDialableCallerID>
xs :boolean </enableDialableCallerID>
[0..1]
<allowConfigurableCLIDForRedirectingIdentity>
xs :boolean </allowConfigurableCLIDForRedirectingIdentity>
[0..1]
<allowDepartmentCLIDNameOverride>
xs :boolean </allowDepartmentCLIDNameOverride>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCallProcessingModifyPolicyRequest15sp2 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
useGroupCLIDSetting "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useGroupMediaSetting "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useGroupCallLimitsSetting "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useGroupTranslationRoutingSetting "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useGroupDCLIDSetting "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useMaxSimultaneousCalls "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useMaxSimultaneousVideoCalls "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useMaxCallTimeForAnsweredCalls "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useMaxCallTimeForUnansweredCalls "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
supportedMediaSetName "
type ="
MediaSetName
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
enforceGroupCallingLineIdentityRestriction "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
allowEnterpriseGroupCallTypingForPrivateDialingPlan "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
allowEnterpriseGroupCallTypingForPublicDialingPlan "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
overrideCLIDRestrictionForPrivateCallCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useEnterpriseCLIDForPrivateCallCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
enableEnterpriseExtensionDialing "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useMaxConcurrentRedirectedCalls "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useMaxFindMeFollowMeDepth "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useMaxConcurrentFindMeFollowMeInvocations "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
emergencyClidPolicy "
type ="
GroupCLIDPolicy
"
minOccurs ="
0 "/>
<
xs:element name ="
allowAlternateNumbersForRedirectingIdentity "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
useGroupName "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
blockCallingNameForExternalCalls "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
enableDialableCallerID "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
allowConfigurableCLIDForRedirectingIdentity "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
allowDepartmentCLIDNameOverride "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommonPhoneListAddListRequest
Abstract
no
Documentation
Add one or more entries to a group's common phone list.
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 ="
GroupCommonPhoneListAddListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
entry "
type ="
PhoneListEntry
"
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommonPhoneListDeleteListRequest
Abstract
no
Documentation
Delete one or more entries from a group's common phone list.
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 ="
GroupCommonPhoneListDeleteListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommonPhoneListGetListRequest
Abstract
no
Documentation
Get a group's common phone list.
The response is either a GroupCommonPhoneListGetListResponse or an ErrorResponse.
The search can be done using multiple criterion.
If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results.
Otherwise, only results matching all the search criterion are included in the results.
If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse.
In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an
ErrorResponse is returned.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCommonPhoneListGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
searchCriteriaModeOr "
type ="
xs :boolean
"
fixed ="
true "
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupCommonPhoneListGetListResponse
Abstract
no
Documentation
Response to the GroupCommonPhoneListGetListRequest.
The response contains the group's common phone list.
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 ="
GroupCommonPhoneListGetListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
entry "
type ="
PhoneListEntry
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommonPhoneListModifyRequest
Abstract
no
Documentation
Modify an entry in a group's common phone list.
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 ="
GroupCommonPhoneListModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
phoneNumber "
type ="
OutgoingDN
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommunicationBarringAuthorizationCodeAddListRequest
Abstract
no
Documentation
Add a list of Communication Barring Authorization codes to a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCommunicationBarringAuthorizationCodeAddListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommunicationBarringAuthorizationCodeDeleteListRequest
Abstract
no
Documentation
Delete a list of Communication Barring Authorization codes from a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCommunicationBarringAuthorizationCodeDeleteListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommunicationBarringAuthorizationCodeGetListRequest
Abstract
no
Documentation
Get a list of Communication Barring Authorization Codes for a group.
The response is either a GroupCommunicationBarringAuthorizationCodeGetListResponse
or an ErorResponse.
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 ="
GroupCommunicationBarringAuthorizationCodeGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupCommunicationBarringAuthorizationCodeGetListResponse
Abstract
no
Documentation
Response to GroupCommunicationBarringAuthorizationCodeGetListRequest.
Contains a list of Communication Barring Authorization Codes
assigned to the group.
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 ="
GroupCommunicationBarringAuthorizationCodeGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommunicationBarringGetRequest
Abstract
no
Documentation
Gets Communication Barring setting for a group.
The response is either a GroupCommunicationBarringGetResponse 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 ="
GroupCommunicationBarringGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupCommunicationBarringGetResponse
Abstract
no
Documentation
Response to SystemCommunicationBarringGetRequest.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<useDefaultServiceProviderProfile>
xs :boolean </useDefaultServiceProviderProfile>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCommunicationBarringGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
useDefaultServiceProviderProfile "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommunicationBarringModifyRequest
Abstract
no
Documentation
Gets Communication Barring setting for a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<useDefaultServiceProviderProfile>
xs :boolean </useDefaultServiceProviderProfile>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCommunicationBarringModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
useDefaultServiceProviderProfile "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommunicationBarringProfileGetAssignedListRequest
Abstract
no
Documentation
Get the list of all communication barring profiles assigned to the group. The response is either a
GroupCommunicationBarringProfileGetAssignedListResponse or an ErrorResponse.
This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider.
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 ="
GroupCommunicationBarringProfileGetAssignedListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupCommunicationBarringProfileGetAssignedListResponse
Abstract
no
Documentation
Response to the GroupCommunicationBarringProfileGetAssignedListRequest.
The response contains a simple list of all communication barring profiles assigned to the group.
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 ="
GroupCommunicationBarringProfileGetAssignedListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCommunicationBarringProfileModifyListRequest
Abstract
no
Documentation
Assign a replacement list of Communication Barring Profiles to a group.
The response is either a SuccessResponse or an ErrorResponse.
This command only applies to groups in an Enterprise. This command will fail for groups in a Service Provider.
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 ="
GroupCommunicationBarringProfileModifyListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCPEConfigRebuildConfigFileRequest
Abstract
no
Documentation
Rebuild the group default config file for the specified device type.
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. -->
<force> true </force> [0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCPEConfigRebuildConfigFileRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
force "
type ="
xs :boolean
"
minOccurs ="
0 "
fixed ="
true "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCPEConfigRebuildDeviceConfigFileRequest
Abstract
no
Documentation
Rebuild the config file for a specified device.
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 ="
GroupCPEConfigRebuildDeviceConfigFileRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCPEConfigReorderDeviceLinePortsRequest
Abstract
no
Documentation
Reorder the lines of a group device. You can not add or delete line ports, only
re-ordering the list is allowed. The ordered list of line ports can be obtained
with the GroupAccessDeviceGetRequest16 command.
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 ="
GroupCPEConfigReorderDeviceLinePortsRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCPEConfigResetDeviceRequest
Abstract
no
Documentation
Reset a specific group device.
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 ="
GroupCPEConfigResetDeviceRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCPEConfigResetDeviceTypeRequest
Abstract
no
Documentation
Reset all the devices of the specified device type in a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCPEConfigResetDeviceTypeRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCPEConfigSetConfigFileRequest
Abstract
no
Documentation
Request to set a new group default configuration file for a device type.
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 ="
GroupCPEConfigSetConfigFileRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCustomContactDirectoryAddRequest17
Abstract
no
Documentation
Adds a Custom Contact Directory to 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCustomContactDirectoryAddRequest17 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCustomContactDirectoryDeleteRequest
Abstract
no
Documentation
Deletes a Custom Contact Directory to 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCustomContactDirectoryDeleteRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCustomContactDirectoryGetAvailableUserListRequest17
Abstract
no
Documentation
Get a list of users that can be part of a custom contact directory.
The response is either GroupCustomContactDirectoryGetAvailableUserListResponse17 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 ="
GroupCustomContactDirectoryGetAvailableUserListRequest17 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
searchCriteriaUserId "
type ="
SearchCriteriaUserId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaDn "
type ="
SearchCriteriaDn
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupCustomContactDirectoryGetAvailableUserListResponse17
Abstract
no
Documentation
Response to the
GroupCustomContactDirectoryGetAvailableUserListRequest17.
Contains a table with column headings: "User Id", "Last Name",
"First Name", "Hiragana Last Name", "Hiragana First Name",
"Virtual On-Net Phone Number", "Group Id", "Is Virtual On-Net User",
"Phone Number", "Extension", "Department", "Email Address".
If the entry represents a Virtual On-Net user then "User Id" is blank,
the "Virtual On-Net Phone Number" contains the phone Number of the
Virtual On-Net user, the "Group Id" contains the Virtual On-Net user's
group and the "Is Virtual On-Net User" contains true.
If the entry represents a BroadWorks user then the "User Id" contains
his BroadWorks userId, the "Virtual On-Net Phone Number" and
"Group Id" fields are blank and the "Is Virtual On-Net User"
contains 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 ="
GroupCustomContactDirectoryGetAvailableUserListResponse17 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCustomContactDirectoryGetListRequest
Abstract
no
Documentation
Gets the list of Custom Contact Directories for a group.
The response is either GroupCustomContactDirectoryGetListResponse 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 ="
GroupCustomContactDirectoryGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupCustomContactDirectoryGetListResponse
Abstract
no
Documentation
Response to the GroupCustomContactDirectoryGetListRequest.
The response contains all the group's custom contact directory names.
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 ="
GroupCustomContactDirectoryGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCustomContactDirectoryGetRequest17
Abstract
no
Documentation
Gets a Custom Contact Directory in a group.
The response is either GroupCustomContactDirectoryGetResponse17 or
ErrorResponse.
The search can be done using multiple criterion.
If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results.
Otherwise, only results matching all the search criterion are included in the results.
If no search criteria is specified, all results are returned.
Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse.
In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an
ErrorResponse is returned.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCustomContactDirectoryGetRequest17 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
searchCriteriaModeOr "
type ="
xs :boolean
"
fixed ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
searchCriteriaDn "
type ="
SearchCriteriaDn
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaUserId "
type ="
SearchCriteriaUserId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaImpId "
type ="
SearchCriteriaImpId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupCustomContactDirectoryGetResponse17
Abstract
no
Documentation
Response to the GroupCustomContactDirectoryGetRequest17.
The response contains all the contacts in the group's given custom
contact directory. Contains a table with column headings: "User Id",
"Last Name", "First Name", "Hiragana Last Name",
"Hiragana First Name", "Virtual On-Net Phone Number", "Group Id",
"Is Virtual On-Net User", "Department", "Phone Number", "Extension",
"Mobile", "Email Address", "Yahoo Id", "Title", "IMP Id".
If the entry represents a Virtual On-Net user then "User Id" is blank,
the "Virtual On-Net Phone Number" contains the phone Number of the
Virtual On-Net user, the "Group Id" contains the Virtual On-Net user's
group and the "Is Virtual On-Net User" contains true.
If the entry represents a BroadWorks user then the "User Id" contains
his BroadWorks userId, the "Virtual On-Net Phone Number" and
"Group Id" fields are field is blank and the "Is Virtual On-Net User"
contains 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 ="
GroupCustomContactDirectoryGetResponse17 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupCustomContactDirectoryModifyRequest17
Abstract
no
Documentation
Adds a Custom Contact Directory to 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupCustomContactDirectoryModifyRequest17 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeleteRequest
Abstract
no
Documentation
Delete a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeleteRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentAddRequest
Abstract
no
Documentation
Add a department to a group.
The response is either a SuccessResponse or an ErrorResponse.
The following elements are only used in AS data mode:
callingLineIdName
caliingLineIdPhoneNumber
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<parentDepartmentKey>
DepartmentKey
</parentDepartmentKey>
[0..1]
<callingLineIdPhoneNumber>
DN
</callingLineIdPhoneNumber>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDepartmentAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
parentDepartmentKey "
type ="
DepartmentKey
"
minOccurs ="
0 "/>
<
xs:element name ="
callingLineIdPhoneNumber "
type ="
DN
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentAdminAddRequest
Abstract
no
Documentation
Add a department administrator to a group department.
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 ="
GroupDepartmentAdminAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
userId "
type ="
UserId
"/>
<
xs:element name ="
firstName "
type ="
FirstName
"
minOccurs ="
0 "/>
<
xs:element name ="
lastName "
type ="
LastName
"
minOccurs ="
0 "/>
<
xs:element name ="
password "
type ="
Password
"
minOccurs ="
0 "/>
<
xs:element name ="
language "
type ="
Language
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentAdminDeleteRequest
Abstract
no
Documentation
Delete a group department administrator.
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 ="
GroupDepartmentAdminDeleteRequest ">
<
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:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentAdminGetListRequest
Abstract
no
Documentation
Get a list of department administrators for the department.
The response is either a GroupDepartmentAdminGetListResponse 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 ="
GroupDepartmentAdminGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDepartmentAdminGetListResponse
Abstract
no
Documentation
Response to GroupDepartmentAdminGetListRequest.
Contains a 5 column table with column headings "Administrator ID",
"Last Name", "First Name", "Department", "Language".
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<departmentAdminTable>
core :OCITable
</departmentAdminTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDepartmentAdminGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentAdminGetRequest
Abstract
no
Documentation
Get a group department administrators profile.
The response is either a GroupDepartmentAdminGetResponse 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 ="
GroupDepartmentAdminGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
userId "
type ="
UserId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDepartmentAdminGetResponse
Abstract
no
Documentation
Response to the GroupDepartmentAdminGetRequest.
The response contains the group department administrators profile information.
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 ="
GroupDepartmentAdminGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
firstName "
type ="
FirstName
"
minOccurs ="
0 "/>
<
xs:element name ="
lastName "
type ="
LastName
"
minOccurs ="
0 "/>
<
xs:element name ="
language "
type ="
Language
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentAdminModifyRequest
Abstract
no
Documentation
Modify a group department administrator.
Since old password is not specified here, any password rule related to old password
does not apply.
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 ="
GroupDepartmentAdminModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
userId "
type ="
UserId
"/>
<
xs:element name ="
firstName "
type ="
FirstName
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
lastName "
type ="
LastName
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
password "
type ="
Password
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
language "
type ="
Language
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentDeleteRequest
Abstract
no
Documentation
Delete a department from a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDepartmentDeleteRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentGetAvailableParentListRequest
Abstract
no
Documentation
Get a list of departments that could be the parent department of the specified
department. The department itself and all its descendents are not eligible to be
the parent department. If the group belongs to an enterprise, it also returns the
departments defined in the enterprise it belongs to.
The response is either GroupDepartmentGetAvailableParentListResponse 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 ="
GroupDepartmentGetAvailableParentListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDepartmentGetAvailableParentListResponse
Abstract
no
Documentation
Response to GroupDepartmentGetAvailableParentListRequest.
The response includes two parallel arrays of department keys and department display names.
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 ="
GroupDepartmentGetAvailableParentListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
departmentKey "
type ="
DepartmentKey
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentGetListRequest18
Abstract
no
Documentation
Request a list of departments in a group. You may request only the
list of departments defined at the group-level, or you may request
the list of all departments in the group including all the departments
defined within the enterprise the group belongs to.
The response is either GroupDepartmentGetListResponse18 or ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<includeEnterpriseDepartments>
xs :boolean </includeEnterpriseDepartments>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDepartmentGetListRequest18 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
includeEnterpriseDepartments "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDepartmentGetListResponse18
Abstract
no
Documentation
Response to GroupDepartmentGetListRequest18.
Contains a table of department attributes.
The column headings are: "Is Enterprise Department", "Department Name", "Full Path Name", "Calling Line Id Name", and "Calling Line Id Phone Number"
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 ="
GroupDepartmentGetListResponse18 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentGetRequest
Abstract
no
Documentation
Request the attributes of a department.
The response is either a GroupDepartmentGetResponse 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 ="
GroupDepartmentGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDepartmentGetResponse
Abstract
no
Documentation
Response to GroupDepartmentGetRequest.
The following elements are only used in AS data mode:
callingLineIdName
caliingLineIdPhoneNumber
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<parentDepartmentKey>
DepartmentKey
</parentDepartmentKey>
[0..1]
<callingLineIdPhoneNumber>
DN
</callingLineIdPhoneNumber>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDepartmentGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
parentDepartmentKey "
type ="
DepartmentKey
"
minOccurs ="
0 "/>
<
xs:element name ="
callingLineIdPhoneNumber "
type ="
DN
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDepartmentModifyRequest
Abstract
no
Documentation
Modify a department of a group.
The response is either a SuccessResponse or an ErrorResponse.
The following elements are only used in AS data mode:
callingLineIdName
caliingLineIdPhoneNumber
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<newParentDepartmentKey>
DepartmentKey
</newParentDepartmentKey>
[0..1]
<callingLineIdPhoneNumber>
DN
</callingLineIdPhoneNumber>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDepartmentModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
newDepartmentName "
type ="
DepartmentName
"
minOccurs ="
0 "/>
<
xs:element name ="
newParentDepartmentKey "
type ="
DepartmentKey
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
callingLineIdPhoneNumber "
type ="
DN
"
nillable ="
true "
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceManagementEventGetListRequest
Abstract
no
Documentation
Request device management's events for a specific queue.
It is possible to restrict the number of rows returned using
responseSizeLimit.
If eventQueueType is not specified, the events from all the
event queues are returned.
The response is either a GroupDeviceManagementEventGetListResponse 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 ="
GroupDeviceManagementEventGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDeviceManagementEventGetListResponse
Abstract
no
Documentation
Response to GroupDeviceManagementEventGetListRequest.
Contains a table with column headings: "Event Id", "Status", "Action",
"Level", "Type", "Additional Info", "Is Local", "Completion %",
"Pushed/ Same Hash/ Not Pushed", "Login Id", "Start Time",
"Process Time".
"Event Id" is a unique identifer for the event.
"Status" can be: Pending, Queued, In Progress,
Process On Other Host, Stale, Completed, Canceled.
"Action" can be: Delete, Download, Rebuild, Reset, Upload.
"Level" can be: Device, Device Type, Device Type Group, Group, User.
"Type" can be: Automatic, Manual.
"Additional Info" includes the affected device type, device or group.
It depends on the level of the event:
Device Profile: "Device Name" "Service Provider Id" "Group Id"
Device Type: "Device Type Name"
Device Type Group: "Service Provider Id" "Group Id" "Device Type Name"
Group: "Service Provider Id" "Group Id"
User: "User Id"
"Is Local" is set to "yes" if the event is processed on the server
who received the request, "no" otherwise meaning that the event is
processed on another server.
"Completion %" provides an estimate of the completion of the event.
A percentage is given, the current number of completed expanded event,
and the total number of expanded event.
"Pushed/ Same Hash/ Not Pushed" gives the total number of files that
were pushed, not pushed because of same hash, and not pushed when
processing the event.
"LoginId" is the user or admin id who triggered the event.
"Start Time" is the date when the event was started. The display
shows the month, days, hours, and minutes (MM-dd hh:mm).
"Process Time" is the time taken to process the event in hours,
minutes, seconds, and milliseconds (hhhh:mm:ss.SSS).
Each row represents an event sorted by priority of processing. The
first row in the table is an event that has an associated expanded
event currently being processed or next in line to be processed.
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 ="
GroupDeviceManagementEventGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupRequest
Abstract
no
Documentation
Request the number of access device of a particular device type and group.
If countOnlyResetSupportedDevice is true, count only access devices if the device type supports reset.
Devices are counted only if their device type supports Device Management.
An error is returned if deviceType is specified but does not support device management.
The response is either GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<countOnlyResetSupportedDevice>
xs :boolean </countOnlyResetSupportedDevice>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
countOnlyResetSupportedDevice "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupResponse
Abstract
no
Documentation
Response to GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupRequest.
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. -->
<accessDeviceCount>
xs :int </accessDeviceCount>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceManagementGetAccessDeviceCountForDeviceTypeGroupResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
accessDeviceCount "
type ="
xs :int
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceManagementInProgressAndPendingEventCancelRequest
Abstract
no
Documentation
Cancel pending and in progress events. A list of individual events can
be canceled.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<eventId>
xs :int </eventId>
[1..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceManagementInProgressAndPendingEventCancelRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
eventId "
type ="
xs :int
"
minOccurs ="
1 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceTypeCustomTagAddRequest
Abstract
no
Documentation
Request to add a static configuration tag for an access device type used in a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceTypeCustomTagAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceTypeCustomTagDeleteListRequest
Abstract
no
Documentation
Request to delete static configuration tags for an access device type used in a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceTypeCustomTagDeleteListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceTypeCustomTagGetListRequest
Abstract
no
Documentation
Request to get the list of custom configuration tags managed by the Device Management System, on a per-device type basis for a group.
The response is either GroupDeviceTypeCustomTagGetListResponse 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 ="
GroupDeviceTypeCustomTagGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDeviceTypeCustomTagGetListResponse
Abstract
no
Documentation
Response to GroupDeviceTypeCustomTagGetListRequest.
Contains a table of custom configuration tags managed by the Device Management System on a per-device type basis for a group.
The column headings are: "Tag Name", "Tag Value"
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<groupDeviceTypeCustomTagsTable>
core :OCITable
</groupDeviceTypeCustomTagsTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceTypeCustomTagGetListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
groupDeviceTypeCustomTagsTable "
type ="
core :OCITable
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceTypeCustomTagModifyRequest
Abstract
no
Documentation
Request to modify a static configuration tag for an access device type used in a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceTypeCustomTagModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceTypeFileGetListRequest14sp8
Abstract
no
Documentation
Request to get the list of device type files managed by the Device Management System, on a per-group basis.
The response is either GroupDeviceTypeFileGetListResponse14sp8 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 ="
GroupDeviceTypeFileGetListRequest14sp8 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDeviceTypeFileGetListResponse14sp8
Abstract
no
Documentation
Response to GroupDeviceTypeFileGetListRequest14sp8.
Contains a table of device type files managed by the Device Management System, on a per-group basis.
The column headings are: "File Format", "Is Authenticated", "Access URL", "Repository URL", "Template URL".
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<groupDeviceTypeFilesTable>
core :OCITable
</groupDeviceTypeFilesTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceTypeFileGetListResponse14sp8 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
groupDeviceTypeFilesTable "
type ="
core :OCITable
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceTypeFileGetRequest16sp1
Abstract
no
Documentation
Request to get a group device type file.
The response is either GroupDeviceTypeFileGetResponse16sp1 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 ="
GroupDeviceTypeFileGetRequest16sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDeviceTypeFileGetResponse16sp1
Abstract
no
Documentation
Response to GroupDeviceTypeFileGetRequest16sp1.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<accessUrl>
URL
</accessUrl>
[1]
<repositoryUrl>
URL
</repositoryUrl>
[0..1]
<templateUrl>
URL
</templateUrl>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceTypeFileGetResponse16sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
accessUrl "
type ="
URL
"/>
<
xs:element name ="
repositoryUrl "
type ="
URL
"
minOccurs ="
0 "/>
<
xs:element name ="
templateUrl "
type ="
URL
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDeviceTypeFileModifyRequest14sp8
Abstract
no
Documentation
Request to modify a specified device type file for a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDeviceTypeFileModifyRequest14sp8 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
uploadFile "
type ="
FileResource
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialableCallerIDCriteriaAddRequest
Abstract
no
Documentation
Add a new Dialable Caller ID Criteria. Criteria are added at the bottom of the list with the lowest priority. The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<matchLocalCategory>
xs :boolean </matchLocalCategory>
[1]
<matchNationalCategory>
xs :boolean </matchNationalCategory>
[1]
<matchInterlataCategory>
xs :boolean </matchInterlataCategory>
[1]
<matchIntralataCategory>
xs :boolean </matchIntralataCategory>
[1]
<matchInternationalCategory>
xs :boolean </matchInternationalCategory>
[1]
<matchPrivateCategory>
xs :boolean </matchPrivateCategory>
[1]
<matchEmergencyCategory>
xs :boolean </matchEmergencyCategory>
[1]
<matchOtherCategory>
xs :boolean </matchOtherCategory>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialableCallerIDCriteriaAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
matchLocalCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchNationalCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchInterlataCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchIntralataCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchInternationalCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchPrivateCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchEmergencyCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchOtherCategory "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialableCallerIDCriteriaDeleteRequest
Abstract
no
Documentation
Delete a Dialable Caller ID Criteria.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialableCallerIDCriteriaDeleteRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialableCallerIDCriteriaGetRequest
Abstract
no
Documentation
Get an existing Dialable Caller ID Criteria.
The response is either a
GroupDialableCallerIDCriteriaGetRequest 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 ="
GroupDialableCallerIDCriteriaGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDialableCallerIDCriteriaGetResponse
Abstract
no
Documentation
Response to the GroupDialableCallerIDCriteriaGetRequest.
The response contains the Dialable Caller ID Criteria information.
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. -->
<matchLocalCategory>
xs :boolean </matchLocalCategory>
[1]
<matchNationalCategory>
xs :boolean </matchNationalCategory>
[1]
<matchInterlataCategory>
xs :boolean </matchInterlataCategory>
[1]
<matchIntralataCategory>
xs :boolean </matchIntralataCategory>
[1]
<matchInternationalCategory>
xs :boolean </matchInternationalCategory>
[1]
<matchPrivateCategory>
xs :boolean </matchPrivateCategory>
[1]
<matchEmergencyCategory>
xs :boolean </matchEmergencyCategory>
[1]
<matchOtherCategory>
xs :boolean </matchOtherCategory>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialableCallerIDCriteriaGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
matchLocalCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchNationalCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchInterlataCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchIntralataCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchInternationalCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchPrivateCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchEmergencyCategory "
type ="
xs :boolean
"/>
<
xs:element name ="
matchOtherCategory "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialableCallerIDCriteriaModifyRequest
Abstract
no
Documentation
Modify a Dialable Caller ID Criteria.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<matchLocalCategory>
xs :boolean </matchLocalCategory>
[0..1]
<matchNationalCategory>
xs :boolean </matchNationalCategory>
[0..1]
<matchInterlataCategory>
xs :boolean </matchInterlataCategory>
[0..1]
<matchIntralataCategory>
xs :boolean </matchIntralataCategory>
[0..1]
<matchInternationalCategory>
xs :boolean </matchInternationalCategory>
[0..1]
<matchPrivateCategory>
xs :boolean </matchPrivateCategory>
[0..1]
<matchEmergencyCategory>
xs :boolean </matchEmergencyCategory>
[0..1]
<matchOtherCategory>
xs :boolean </matchOtherCategory>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialableCallerIDCriteriaModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
matchLocalCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
matchNationalCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
matchInterlataCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
matchIntralataCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
matchInternationalCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
matchPrivateCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
matchEmergencyCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
matchOtherCategory "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialableCallerIDGetRequest
Abstract
no
Documentation
Get the Group’s Dialable Caller ID settings and criteria list.
The response is either a
GroupDialableCallerIDGetResponse 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 ="
GroupDialableCallerIDGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDialableCallerIDGetResponse
Abstract
no
Documentation
Response to the GroupDialableCallerIDGetRequest.
The criteria table�s column headings are "Active", "Name", "Description", �Prefix Digits�, �Priority�.
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. -->
<useGroupCriteria>
xs :boolean </useGroupCriteria>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialableCallerIDGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
useGroupCriteria "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialableCallerIDModifyRequest
Abstract
no
Documentation
Modify the group�s Dialable Caller ID settings and criteria list.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<useGroupCriteria>
xs :boolean </useGroupCriteria>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialableCallerIDModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
useGroupCriteria "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialPlanPolicyAddAccessCodeRequest
Abstract
no
Documentation
Request to add a Group level Dial Plan Access Code and its all attribues.
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. -->
<includeCodeForNetworkTranslationsAndRouting>
xs :boolean </includeCodeForNetworkTranslationsAndRouting>
[1]
<includeCodeForScreeningServices>
xs :boolean </includeCodeForScreeningServices>
[1]
<enableSecondaryDialTone>
xs :boolean </enableSecondaryDialTone>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialPlanPolicyAddAccessCodeRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
includeCodeForNetworkTranslationsAndRouting "
type ="
xs :boolean
"/>
<
xs:element name ="
includeCodeForScreeningServices "
type ="
xs :boolean
"/>
<
xs:element name ="
enableSecondaryDialTone "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialPlanPolicyDeleteAccessCodeRequest
Abstract
no
Documentation
Request to delete a Group level Dial Plan Access Code and its all attribues.
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 ="
GroupDialPlanPolicyDeleteAccessCodeRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialPlanPolicyGetAccessCodeListRequest
Abstract
no
Documentation
Request the Group level data associated with Dial Plan Policy.
The response is either a GroupDialPlanPolicyGetAccessCodeListResponse
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 ="
GroupDialPlanPolicyGetAccessCodeListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDialPlanPolicyGetAccessCodeListResponse
Abstract
no
Documentation
Response to GroupDialPlanPolicyGetAccessCodeListRequest
Contains a table with column headings: "Access Code",
"Enable Secondary Dial Tone", "Description"
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 ="
GroupDialPlanPolicyGetAccessCodeListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialPlanPolicyGetAccessCodeRequest
Abstract
no
Documentation
Request access code data associated with Group level Dial Plan Policy access codes.
The response is either a GroupDialPlanPolicyGetAccessCodeResponse 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 ="
GroupDialPlanPolicyGetAccessCodeRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDialPlanPolicyGetAccessCodeResponse
Abstract
no
Documentation
Response to GroupDialPlanPolicyGetAccessCodeRequest
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<includeCodeForNetworkTranslationsAndRouting>
xs :boolean </includeCodeForNetworkTranslationsAndRouting>
[1]
<includeCodeForScreeningServices>
xs :boolean </includeCodeForScreeningServices>
[1]
<enableSecondaryDialTone>
xs :boolean </enableSecondaryDialTone>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialPlanPolicyGetAccessCodeResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
includeCodeForNetworkTranslationsAndRouting "
type ="
xs :boolean
"/>
<
xs:element name ="
includeCodeForScreeningServices "
type ="
xs :boolean
"/>
<
xs:element name ="
enableSecondaryDialTone "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialPlanPolicyGetRequest17
Abstract
no
Documentation
Request the Group level data associated with Dial Plan Policy.
The response is either a GroupDialPlanPolicyGetResponse17 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 ="
GroupDialPlanPolicyGetRequest17 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDialPlanPolicyGetResponse17
Abstract
no
Documentation
Response to GroupDialPlanPolicyGetRequest17
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<requiresAccessCodeForPublicCalls>
xs :boolean </requiresAccessCodeForPublicCalls>
[1]
<allowE164PublicCalls>
xs :boolean </allowE164PublicCalls>
[1]
<preferE164NumberFormatForCallbackServices>
xs :boolean </preferE164NumberFormatForCallbackServices>
[1]
<publicDigitMap>
DigitMap
</publicDigitMap>
[0..1]
<privateDigitMap>
DigitMap
</privateDigitMap>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialPlanPolicyGetResponse17 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
requiresAccessCodeForPublicCalls "
type ="
xs :boolean
"/>
<
xs:element name ="
allowE164PublicCalls "
type ="
xs :boolean
"/>
<
xs:element name ="
preferE164NumberFormatForCallbackServices "
type ="
xs :boolean
"/>
<
xs:element name ="
publicDigitMap "
type ="
DigitMap
"
minOccurs ="
0 "/>
<
xs:element name ="
privateDigitMap "
type ="
DigitMap
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialPlanPolicyModifyAccessCodeRequest
Abstract
no
Documentation
Request to modify a Group level Dial Plan Access Code and its attribues.
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. -->
<includeCodeForNetworkTranslationsAndRouting>
xs :boolean </includeCodeForNetworkTranslationsAndRouting>
[0..1]
<includeCodeForScreeningServices>
xs :boolean </includeCodeForScreeningServices>
[0..1]
<enableSecondaryDialTone>
xs :boolean </enableSecondaryDialTone>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialPlanPolicyModifyAccessCodeRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
includeCodeForNetworkTranslationsAndRouting "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
includeCodeForScreeningServices "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
enableSecondaryDialTone "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDialPlanPolicyModifyRequest
Abstract
no
Documentation
Modify the Group level data associated with Dial Plan 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. -->
<requiresAccessCodeForPublicCalls>
xs :boolean </requiresAccessCodeForPublicCalls>
[0..1]
<allowE164PublicCalls>
xs :boolean </allowE164PublicCalls>
[0..1]
<preferE164NumberFormatForCallbackServices>
xs :boolean </preferE164NumberFormatForCallbackServices>
[0..1]
<publicDigitMap>
DigitMap
</publicDigitMap>
[0..1]
<privateDigitMap>
DigitMap
</privateDigitMap>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDialPlanPolicyModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
requiresAccessCodeForPublicCalls "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
allowE164PublicCalls "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
preferE164NumberFormatForCallbackServices "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
publicDigitMap "
type ="
DigitMap
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
privateDigitMap "
type ="
DigitMap
"
nillable ="
true "
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDigitCollectionGetRequest13mp4
Abstract
no
Documentation
Request the group's digit collection attributes.
The response is either a GroupDigitCollectionGetResponse13mp4 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 ="
GroupDigitCollectionGetRequest13mp4 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDigitCollectionGetResponse13mp4
Abstract
no
Documentation
Response to GroupDigitCollectionGetRequest13mp4.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<publicDigitMap>
DigitMap
</publicDigitMap>
[0..1]
<privateDigitMap>
DigitMap
</privateDigitMap>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDigitCollectionGetResponse13mp4 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
accessCode "
type ="
AccessCode
"
minOccurs ="
0 "/>
<
xs:element name ="
publicDigitMap "
type ="
DigitMap
"
minOccurs ="
0 "/>
<
xs:element name ="
privateDigitMap "
type ="
DigitMap
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDigitCollectionModifyRequest
Abstract
no
Documentation
Modifies the group's digit collection 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. -->
<publicDigitMap>
DigitMap
</publicDigitMap>
[0..1]
<privateDigitMap>
DigitMap
</privateDigitMap>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDigitCollectionModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
accessCode "
type ="
AccessCode
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
publicDigitMap "
type ="
DigitMap
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
privateDigitMap "
type ="
DigitMap
"
nillable ="
true "
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnActivateListRequest
Abstract
no
Documentation
Activate a list of assigned DNs on a group. It is possible to activate either: a single DN,
or a list of DNs, or a range of DNs, or any combination thereof.
It is not an error to activate an already activated DN
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. -->
<phoneNumber>
DN
</phoneNumber>
[0..*]
<dnRange>
DNRange
</dnRange>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDnActivateListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
phoneNumber "
type ="
DN
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
dnRange "
type ="
DNRange
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnAssignListRequest
Abstract
no
Documentation
Assign a list of service provider DNs to a group. It is possible to assign either: a single DN,
or a list of DNs, or a range of DNs, or any combination thereof.
The DNs must have previously been added to the service provider or enterprise.
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. -->
<phoneNumber>
DN
</phoneNumber>
[0..*]
<dnRange>
DNRange
</dnRange>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDnAssignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
phoneNumber "
type ="
DN
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
dnRange "
type ="
DNRange
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnDeactivateListRequest
Abstract
no
Documentation
Deactivate a list of activated DNs on a group. The DNs then become available for
activation again. It is possible to deactivate either: a single DN,
or a list of DNs, or a range of DNs, or any combination thereof.
It is not an error to deactivate an already deactivated DN.
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. -->
<phoneNumber>
DN
</phoneNumber>
[0..*]
<dnRange>
DNRange
</dnRange>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDnDeactivateListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
phoneNumber "
type ="
DN
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
dnRange "
type ="
DNRange
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnGetActivationListRequest
Abstract
no
Documentation
Get the list of activated and deactivated DNs in a group.
Ranges of DNs with identical assignment and activation properties are coalesced
to a single table row entry.
Only DNs assigned to a users are listed in the response when the number
activation Mode is set to "User Activation Enabled"
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetActivationListResponse 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 ="
GroupDnGetActivationListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDnGetActivationListResponse
Abstract
no
Documentation
Response to the GroupDnGetActivationListRequest.
The response contains a table with columns: "Phone Numbers", and "Activated". ". Phone Numbers are only returned if assigned to a user.
The "Phone Numbers" column contains either a single DN or a range of DNs.
The "Activated" column indicates if the phone number(s) are activated or not.
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 ="
GroupDnGetActivationListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnGetAssignmentListRequest18
Abstract
no
Documentation
Get the list of assigned and unassigned DNs in a group. Each DN can be assigned
to a user and/or department. Ranges of DNs with identical assignment and activation properties
are coalesced to a single table row entry.
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetAssignmentListResponse18 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 ="
GroupDnGetAssignmentListRequest18 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
searchCriteriaDn "
type ="
SearchCriteriaDn
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaUserId "
type ="
SearchCriteriaUserId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDnGetAssignmentListResponse18
Abstract
no
Documentation
Response to the GroupDnGetAssignmentListRequest18.
The response contains a table with columns: "Phone Numbers", "Department", "Activated", "User Id",
"Last Name", "First Name", "Extension", "Email Address", "User Type".
The "Phone Numbers" column contains either a single DN or a range of DNs.
The "User Id", "Last Name" and "First Name" columns contains the corresponding attributes of the user possessing the DN(s).
For a service instance, "Last Name" contains the service instance name and "First Name" column contains the corresponding enumerated UserType value.
The "Department" column contains the department of the DN, not the department of the user or service instance.
The "Activated" column indicates if the DN or DN range has been activated. Only has a value if the DN(s) is assigned to a user.
The "User Type" column contains the corresponding enumerated UserType value.
NOTE: the same phone number can show up in the list twice if the phone number is being used as the group calling line Id.
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 ="
GroupDnGetAssignmentListResponse18 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnGetAvailableListRequest
Abstract
no
Documentation
Get the list of DNs that are assigned to a group and still available for
assignment to users or service instances within the group.
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetAvailableListResponse 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 ="
GroupDnGetAvailableListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDnGetAvailableListResponse
Abstract
no
Documentation
Response to the GroupDnGetAvailableListRequest.
The response contains the list of DNs that are assigned to a group and still available for
assignment to users or service instances within the group.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<phoneNumber>
DN
</phoneNumber>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDnGetAvailableListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
phoneNumber "
type ="
DN
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnGetAvailableRangesListRequest
Abstract
no
Documentation
Get a list of group DNs that are not assigned to user, service instances or IMRN pool.
The Dns are returned in a list of DNs or DN ranges and formated in E164 format for display.
The response is either a GroupDnGetAvailableRangeListResponse 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 ="
GroupDnGetAvailableRangesListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDnGetAvailableRangesListResponse
Abstract
no
Documentation
Response to the GroupDnGetAvailableRangesListRequest.
The response contains the list of group DNs that are not assigned to user, service instances or IMRN pool.
The Dns are returned in a list of DNs or DN ranges and formated in E164 format for display.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<phoneNumber>
xs :token </phoneNumber>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDnGetAvailableRangesListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
phoneNumber "
type ="
xs :token
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnGetDetailedAvailableListRequest
Abstract
no
Documentation
Get the list of DNs that are assigned to a group and still available for
assignment to users within the group with the department name, if the DN
is assigned to the department.
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetDetailedAvailableListResponse 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 ="
GroupDnGetDetailedAvailableListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDnGetDetailedAvailableListResponse
Abstract
no
Documentation
Response to the GroupDnGetDetailedAvailableListRequest.
The response contains a table with columns: "Phone Number", "Department".
The "Phone Numbers" column contains a single DN.
The "Department" column contains the department of the DN if the DN is part of the department.
The "Activated" column indicates if the DN has been activated.
Only has a value if the DN(s) is assigned to a user or if "Group
Enable Activation Mode" is enabled.
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 ="
GroupDnGetDetailedAvailableListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnGetListRequest
Abstract
no
Documentation
Get the list of DNs that are assigned to a group.
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetListResponse 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 ="
GroupDnGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDnGetListResponse
Abstract
no
Documentation
Response to the GroupDnGetListRequest.
The response contains the list of DNs assigned to the group.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<phoneNumber>
DN
</phoneNumber>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDnGetListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
phoneNumber "
type ="
DN
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnGetSummaryListRequest
Abstract
no
Documentation
Get the list of assigned and unassigned DN ranges in a group.
Dns assigned to the IMRN pool are not listed in the response.
The response is either a GroupDnGetSummaryListResponse 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 ="
GroupDnGetSummaryListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDnGetSummaryListResponse
Abstract
no
Documentation
Response to the GroupDnGetSummaryListRequest.
The response contains a table with columns: "Phone Numbers", "Assigned".
The "Phone Numbers" column contains either a single DN or a range of DNs.
The "Assigned" column contains a boolean flag indicating if the DN(s) are
currently assigned to a user or service instance.
The "Activated" column indicates if the DN or DN range has been activated.
Only has a value if the DN(s) is assigned to a user or if "Group Enable Activation
Mode" is enabled.
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 ="
GroupDnGetSummaryListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnListAssignDepartmentRequest
Abstract
no
Documentation
Assign a list of group DNs to a department. If the department is not specified, this
will make the DNs become unassigned from any department.
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. -->
<phoneNumber>
DN
</phoneNumber>
[0..*]
<dnRange>
DNRange
</dnRange>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDnListAssignDepartmentRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
departmentKey "
type ="
DepartmentKey
"
minOccurs ="
0 "/>
<
xs:element name ="
phoneNumber "
type ="
DN
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
dnRange "
type ="
DNRange
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDnUnassignListRequest
Abstract
no
Documentation
Unassign a list of service provider DNs from a group. The DNs then become available for
assignment to other groups. It is possible to unassign either: a single DN,
or a list of DNs, or a range of DNs, or any combination thereof.
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. -->
<phoneNumber>
DN
</phoneNumber>
[0..*]
<dnRange>
DNRange
</dnRange>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDnUnassignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
phoneNumber "
type ="
DN
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
dnRange "
type ="
DNRange
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDomainAssignListRequest
Abstract
no
Documentation
Assign a list of domains to 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDomainAssignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
domain "
type ="
NetAddress
"
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDomainGetAssignedListRequest
Abstract
no
Documentation
Requests the list of all domains assigned to a group.
The response is either GroupDomainGetAssignedListResponse 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 ="
GroupDomainGetAssignedListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDomainGetAssignedListResponse
Abstract
no
Documentation
Contains a simple list of all group domain names.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<groupDefaultDomain>
NetAddress
</groupDefaultDomain>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDomainGetAssignedListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
groupDefaultDomain "
type ="
NetAddress
"/>
<
xs:element name ="
domain "
type ="
NetAddress
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDomainGetAssignedUserListRequest
Abstract
no
Documentation
Request a list of users within in a group that have a given domain assigned.
The response is either GroupDomainGetAssignedUserListResponse 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 ="
GroupDomainGetAssignedUserListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
searchCriteriaDn "
type ="
SearchCriteriaDn
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaUserId "
type ="
SearchCriteriaUserId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupDomainGetAssignedUserListResponse
Abstract
no
Documentation
Response to GroupDomainGetAssignedUserListRequest.
The table columns are: "User Id", "Last Name", "First Name", "Department", "Phone Number", "Email Address",
"Service Provider Id", "Group Id", "Hiragana Last Name" and "Hiragana First Name", "Extension".
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 ="
GroupDomainGetAssignedUserListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupDomainUnassignListRequest
Abstract
no
Documentation
Unassign a list of domains 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupDomainUnassignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
domain "
type ="
NetAddress
"
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupEndpointGetListRequest
Abstract
no
Documentation
Request to search endpoints in the group.
The response is either GroupEndpointGetListResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupEndpointGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
searchCriteriaUserId "
type ="
SearchCriteriaUserId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaDn "
type ="
SearchCriteriaDn
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupEndpointGetListResponse
Abstract
no
Documentation
Response to GroupEndpointGetListRequest.
The column headings for the endpointTable are:
"Line/Port", "Last Name", "First Name", "User Id", "User Type", "Phone Number", "Extension", "Device Type", "Device Name", "Net Address", "MAC Address", "Department", "Email Address".
Possible values for User Type are �User�, �CCBasic�, �CCStandard�, �CCPremium�, �RP�, �MOH�, �MOHVideo�.
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 ="
GroupEndpointGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupExchangeIntegrationGetRequest
Abstract
no
Documentation
Request the group level configuration for Exchange Integration.
The response is either a GroupExchangeIntegrationGetResponse 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 ="
GroupExchangeIntegrationGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupExchangeIntegrationGetResponse
Abstract
no
Documentation
Response to GroupExchangeIntegrationGetRequest.
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. -->
<enableExchangeIntegration>
xs :boolean </enableExchangeIntegration>
[1]
<exchangeURL>
URL
</exchangeURL>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupExchangeIntegrationGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
enableExchangeIntegration "
type ="
xs :boolean
"/>
<
xs:element name ="
exchangeURL "
type ="
URL
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupExchangeIntegrationModifyRequest
Abstract
no
Documentation
Modify the group level configuration for Exchange Integration.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<enableExchangeIntegration>
xs :boolean </enableExchangeIntegration>
[0..1]
<exchangeURL>
URL
</exchangeURL>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupExchangeIntegrationModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
enableExchangeIntegration "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
exchangeURL "
type ="
URL
"
minOccurs ="
0 "
nillable ="
true "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupExistingUsersAssignUserServiceListRequest
Abstract
no
Documentation
Request to assign the user services and service packs to all existing users within the group.
BroadSoft recommends using this command only for small groups with less than 100 users. This
command will return an error if the group has over 500 users. The recommended way to bulk
assign/unassign services is Service Pack Migration.
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 ="
GroupExistingUsersAssignUserServiceListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
serviceName "
type ="
UserService
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
servicePackName "
type ="
ServicePackName
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupExistingUsersUnassignUserServiceListRequest
Abstract
no
Documentation
Requests to unassign the user services and service packs for all existing users within the group.
BroadSoft recommends using this command only for small groups with less than 100 users. This
command will return an error if the group has over 500 users. The recommended way to bulk
assign/unassign services is Service Pack Migration.
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 ="
GroupExistingUsersUnassignUserServiceListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
serviceName "
type ="
UserService
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
servicePackName "
type ="
ServicePackName
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupExtensionLengthGetRequest17
Abstract
no
Documentation
Request the group's extension length.
The response is either a GroupExtensionLengthGetResponse17 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 ="
GroupExtensionLengthGetRequest17 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupExtensionLengthGetResponse17
Abstract
no
Documentation
Response to GroupExtensionLengthGetRequest17.
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 ="
GroupExtensionLengthGetResponse17 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupExtensionLengthModifyRequest17
Abstract
no
Documentation
Modify the group's extension length range.
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 ="
GroupExtensionLengthModifyRequest17 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
minExtensionLength "
type ="
ExtensionLength
"
minOccurs ="
0 "/>
<
xs:element name ="
maxExtensionLength "
type ="
ExtensionLength
"
minOccurs ="
0 "/>
<
xs:element name ="
defaultExtensionLength "
type ="
ExtensionLength
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupFeatureAccessCodeGetRequest20
Abstract
no
Documentation
Get group FAC code level and the list of feature access codes for a group.
The response is either a GroupFeatureAccessCodeGetResponse20 or an
ErrorResponse.
Returned Feature Access Codes may be group specific, or Service Provider
Feature Access Codes, depending on FAC code level.
In release 20 the "Call Recording" FAC name is changed to
"Call Recording - Start".
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 ="
GroupFeatureAccessCodeGetRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupFeatureAccessCodeGetResponse20
Abstract
no
Documentation
Response to the GroupFeatureAccessCodeGetRequest20.
In release 20 the "Call Recording" FAC name is changed to
"Call Recording - Start".
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 ="
GroupFeatureAccessCodeGetResponse20 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupFeatureAccessCodeModifyRequest20
Abstract
no
Documentation
Modify group FAC code level and the list of feature access codes for a
group.
The response is either a SuccessResponse or an ErrorResponse.
Note: choice element is only valid when useFeatureAccessCodeLevel is set
to "Group", otherwise an ErrorResponse will be returned.
In release 20 the "Call Recording" FAC name is changed to
"Call Recording - Start".
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. -->
Start Choice [1]
<restoreDefaultCodes> true </restoreDefaultCodes> [0..1]
End Choice
</...>
Schema Component Representation
<
xs:complexType name ="
GroupFeatureAccessCodeModifyRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:choice >
<
xs:element name ="
restoreDefaultCodes "
type ="
xs :boolean
"
fixed ="
true "
minOccurs ="
0 "/>
</
xs:choice >
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupFileRepositoryDeviceUserAddRequest
Abstract
no
Documentation
Add a new group file repository 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. -->
<allowPut>
xs :boolean </allowPut>
[1]
<allowDelete>
xs :boolean </allowDelete>
[1]
<allowGet>
xs :boolean </allowGet>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupFileRepositoryDeviceUserAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
allowPut "
type ="
xs :boolean
"/>
<
xs:element name ="
allowDelete "
type ="
xs :boolean
"/>
<
xs:element name ="
allowGet "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupFileRepositoryDeviceUserDeleteRequest
Abstract
no
Documentation
Delete a group file repository 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 ="
GroupFileRepositoryDeviceUserDeleteRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupFileRepositoryDeviceUserGetListRequest
Abstract
no
Documentation
Request the list of group users for a file repository in the system.
The response is either a GroupFileRepositoryDeviceUserGetListResponse 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 ="
GroupFileRepositoryDeviceUserGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupFileRepositoryDeviceUserGetListResponse
Abstract
no
Documentation
Response to GroupFileRepositoryDeviceUserGetListRequest.
Contains a table with column headings : "User Name","Allow Delete","Allow Get","Allow Put" in a row for each file repository service provider user.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<fileRepositoryUserTable>
core :OCITable
</fileRepositoryUserTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupFileRepositoryDeviceUserGetListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupFileRepositoryDeviceUserModifyRequest
Abstract
no
Documentation
Modify a group file repository 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. -->
<allowPut>
xs :boolean </allowPut>
[0..1]
<allowDelete>
xs :boolean </allowDelete>
[0..1]
<allowGet>
xs :boolean </allowGet>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupFileRepositoryDeviceUserModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
allowPut "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
allowDelete "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
allowGet "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupGetDefaultRequest
Abstract
no
Documentation
Request the default profile for a group.
The response is either a GroupGetDefaultResponse 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 ="
GroupGetDefaultRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupGetDefaultResponse
Abstract
no
Documentation
Response to the GroupGetDefaultRequest. All values are default values for a group's profile.
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 ="
GroupGetDefaultResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
defaultDomain "
type ="
NetAddress
"/>
<
xs:element name ="
timeZone "
type ="
TimeZone
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupGetListInServiceProviderRequest
Abstract
no
Documentation
Request the list of groups in a service provider or enterprise.
It is possible to search by various criteria to restrict the number of rows returned.
Multiple search criteria are logically ANDed together.
The response is either a GroupGetListInServiceProviderResponse 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 ="
GroupGetListInServiceProviderRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
searchCriteriaGroupId "
type ="
SearchCriteriaGroupId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupGetListInServiceProviderResponse
Abstract
no
Documentation
Response to GroupGetListInServiceProviderRequest.
Contains a 3 column table with column headings: "Group Id", "Group Name", "User Limit"
and a row for each group.
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 ="
GroupGetListInServiceProviderResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupGetListInSystemRequest
Abstract
no
Documentation
Request the list of groups in the system.
It is possible to search by various criteria to restrict the number of rows returned.
Multiple search criteria are logically ANDed together.
The response is either a GroupGetListInSystemResponse 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 ="
GroupGetListInSystemRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
searchCriteriaGroupId "
type ="
SearchCriteriaGroupId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupGetListInSystemResponse
Abstract
no
Documentation
Response to GroupGetListInSystemRequest.
Contains a table with column headings: "Group Id", "Group Name", "User Limit", "Organization Id", "Organization Type"
and a row for each group.
The "Organization Id" column is populated with either a service provider Id or an enterprise Id.
The "Organization Type" column is populated with one of the enumerated strings defined in the
OrganizationType OCI data type. Please see OCISchemaDataTypes.xsd for details on OrganizationType.
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 ="
GroupGetListInSystemResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupGetRequest14sp7
Abstract
no
Documentation
Get the profile for a group.
The response is either a GroupGetResponse14sp7 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 ="
GroupGetRequest14sp7 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupGetResponse14sp7
Abstract
no
Documentation
Response to the GroupGetRequest14sp7.
The response contains the group's profile information.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<userCount>
xs :int </userCount>
[1]
<callingLineIdPhoneNumber>
DN
</callingLineIdPhoneNumber>
[0..1]
<callingLineIdDisplayPhoneNumber>
DN
</callingLineIdDisplayPhoneNumber>
[0..1]
<contact>
Contact
</contact>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupGetResponse14sp7 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
defaultDomain "
type ="
NetAddress
"/>
<
xs:element name ="
userCount "
type ="
xs :int
"/>
<
xs:element name ="
groupName "
type ="
GroupName
"
minOccurs ="
0 "/>
<
xs:element name ="
callingLineIdPhoneNumber "
type ="
DN
"
minOccurs ="
0 "/>
<
xs:element name ="
callingLineIdDisplayPhoneNumber "
type ="
DN
"
minOccurs ="
0 "/>
<
xs:element name ="
timeZone "
type ="
TimeZone
"/>
<
xs:element name ="
contact "
type ="
Contact
"
minOccurs ="
0 "/>
<
xs:element name ="
address "
type ="
StreetAddress
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupGetUserServiceAssignedUserListRequest
Abstract
no
Documentation
Get the list of users assigned the user service or service pack.
The response is either a GroupGetUserServiceAssignedUserListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
Start Choice [1]
End Choice
</...>
Schema Component Representation
<
xs:complexType name ="
GroupGetUserServiceAssignedUserListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupGetUserServiceAssignedUserListResponse
Abstract
no
Documentation
Return a table containing the list of users assigned the user service
or service pack. The table contains columns: "User Id", "Last Name",
"First Name", "Department", "Phone Number", "Email Address", "Hiragana Last Name";
"Hiragana First Name", "Extension".
This is a response to the GroupGetUserServiceAssignedUserListRequest.
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 ="
GroupGetUserServiceAssignedUserListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupIMRNAssignListRequest
Abstract
no
Documentation
Assign a list of group DNs to the IMRN pool. It is possible to assign either: a single DN,
or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<imrnRange>
DNRange
</imrnRange>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupIMRNAssignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
imrn "
type ="
DN
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
imrnRange "
type ="
DNRange
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupIMRNGetListRequest
Abstract
no
Documentation
Request a summary table of all DNs in a group IMRN pool.
The response is either GroupIMRNGetListResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupIMRNGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupIMRNGetListResponse
Abstract
no
Documentation
Response to GroupIMRNGetListRequest.
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. -->
<imrn>
xs :token </imrn>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupIMRNGetListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
imrn "
type ="
xs :token
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupIMRNUnassignListRequest
Abstract
no
Documentation
Unassign a list of group DNs from the group IMRN pool. The DNs then become available for
assignment to users. It is possible to delete either: a single DN,
or a list of DNs, or a range of DNs, or any combination thereof.
The response is either SuccessResponse or ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<imrnRange>
DNRange
</imrnRange>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupIMRNUnassignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
imrn "
type ="
DN
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
imrnRange "
type ="
DNRange
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupMaintenancePartitionGetRequest
Abstract
no
Documentation
Get the Maintenance Partition for a group.
The response is either a GroupMaintenancePartitionGetResponse or an ErrorResponse.
Application Data
<asDataModeSupported> false
</asDataModeSupported>
<hssDataModeSupported> true
</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 ="
GroupMaintenancePartitionGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupMaintenancePartitionGetResponse
Abstract
no
Documentation
Response to the GroupMaintenancePartitionGetRequest.
The response contains the Maintenance Partition information of the group.
Application Data
<asDataModeSupported> false
</asDataModeSupported>
<hssDataModeSupported> true
</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 ="
GroupMaintenancePartitionGetResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupMaintenancePartitionModifyRequest
Abstract
no
Documentation
Modify the Maintenance Partition assigned to the group.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> false
</asDataModeSupported>
<hssDataModeSupported> true
</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 ="
GroupMaintenancePartitionModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupModifyRequest
Abstract
no
Documentation
Modify the profile for a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<defaultDomain>
NetAddress
</defaultDomain>
[0..1]
<callingLineIdPhoneNumber>
DN
</callingLineIdPhoneNumber>
[0..1]
<contact>
Contact
</contact>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
defaultDomain "
type ="
NetAddress
"
minOccurs ="
0 "/>
<
xs:element name ="
groupName "
type ="
GroupName
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
callingLineIdPhoneNumber "
type ="
DN
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
timeZone "
type ="
TimeZone
"
minOccurs ="
0 "/>
<
xs:element name ="
locationDialingCode "
type ="
LocationDialingCode
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
contact "
type ="
Contact
"
minOccurs ="
0 "/>
<
xs:element name ="
address "
type ="
StreetAddress
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupNetworkClassOfServiceAssignListRequest
Abstract
no
Documentation
Assign a list of Network Classes of Service to a group.
The Element defaultNetworkClassOfService is required only for the first
assignment, for subsequent assignments it is optional.
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 ="
GroupNetworkClassOfServiceAssignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupNetworkClassOfServiceAssignToAllUsersRequest
Abstract
no
Documentation
Assign a Network Classes of Service to all users with in a
group. The Network Classes of Service must be currently assigned to
the group. The response is either a SuccessResponse or
an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupNetworkClassOfServiceAssignToAllUsersRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupNetworkClassOfServiceGetAssignedListRequest
Abstract
no
Documentation
Get a list of Network Classes of Service assigned to a group.
The response is either a GroupNetworkClassOfServiceGetAssignedListResponse
or an ErorResponse.
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 ="
GroupNetworkClassOfServiceGetAssignedListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupNetworkClassOfServiceGetAssignedListResponse
Abstract
no
Documentation
Response to GroupNetworkClassOfServiceGetAssignedListRequest.
Contains a table of all Network Classes of Service assigned to
the group. The column headings are: "Name", "Description" and "Default".
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<networkClassOfServiceTable>
core :OCITable
</networkClassOfServiceTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupNetworkClassOfServiceGetAssignedListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
networkClassOfServiceTable "
type ="
core :OCITable
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupNetworkClassOfServiceGetAssignedUserListRequest
Abstract
no
Documentation
Get a list of users within a group that have a given Network Class
of Service assigned.
The response is either a GroupNetworkClassOfServiceGetAssignedUserListResponse
or an ErorResponse.
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 ="
GroupNetworkClassOfServiceGetAssignedUserListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
searchCriteriaDn "
type ="
SearchCriteriaDn
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaUserId "
type ="
SearchCriteriaUserId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupNetworkClassOfServiceGetAssignedUserListResponse
Abstract
no
Documentation
Response to GroupNetworkClassOfServiceGetAssignedUserListRequest.
Contains a table of users that have the Network Class of Service
assigned. The column headings are: "User Id", "User Type", "Last Name", "First Name",
"Department", "Phone Number", "Email Address", "Service Provider Id",
"Group Id", "Hiragana Last Name" and "Hiragana First Name" , "Extension".
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 ="
GroupNetworkClassOfServiceGetAssignedUserListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupNetworkClassOfServiceModifyDefaultRequest
Abstract
no
Documentation
Modifies the default Network Classes of Service of a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupNetworkClassOfServiceModifyDefaultRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupNetworkClassOfServiceUnassignListRequest
Abstract
no
Documentation
Unassign a list of Network Classes of Service from a group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupNetworkClassOfServiceUnassignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupNewUserTemplateAssignUserServiceListRequest
Abstract
no
Documentation
Request to assign the user services and service packs to all new users created within the group
after the completion of this request.
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 ="
GroupNewUserTemplateAssignUserServiceListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
serviceName "
type ="
UserService
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
servicePackName "
type ="
ServicePackName
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupNewUserTemplateUnassignUserServiceListRequest
Abstract
no
Documentation
Requests to unassign the user services and service packs for all new users created within the group
after the completion of this request.
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 ="
GroupNewUserTemplateUnassignUserServiceListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
serviceName "
type ="
UserService
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
servicePackName "
type ="
ServicePackName
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupOfficeZoneAssignListRequest
Abstract
no
Documentation
Assign a list of Office Zones to a group.
The Element defaultOfficeZone is required only for the first assignment, for subsequent assignments it is optional.
Office Zones can only be assigned if the Location-Based Calling Restrictions has been authorized to the group otherwise the request will fail.
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. -->
<defaultOfficeZoneName>
OfficeZoneName
</defaultOfficeZoneName>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupOfficeZoneAssignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
officeZoneName "
type ="
OfficeZoneName
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
defaultOfficeZoneName "
type ="
OfficeZoneName
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupOfficeZoneGetAssignedListRequest
Abstract
no
Documentation
Get a list of Office Zones assigned to a group.
The response is either a GroupOfficeZoneGetAssignedListResponse
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 ="
GroupOfficeZoneGetAssignedListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupOfficeZoneGetAssignedListResponse
Abstract
no
Documentation
Response to GroupOfficeZoneGetAssignedListRequest.
Contains a table of all Office Zones assigned to the
group. The column headings are: "Name", "Description" and "Default".
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 ="
GroupOfficeZoneGetAssignedListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupOfficeZoneGetAssignedUserListRequest
Abstract
no
Documentation
Get a list of users within a group that have a given Office Zone assigned.
The response is either a GroupOfficeZoneGetAssignedUserListResponse
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 ="
GroupOfficeZoneGetAssignedUserListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
searchCriteriaDn "
type ="
SearchCriteriaDn
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaUserId "
type ="
SearchCriteriaUserId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupOfficeZoneGetAssignedUserListResponse
Abstract
no
Documentation
Response to GroupOfiiceZoneGetAssignedUserListRequest.
Contains a table of users that have the Office Zone assigned. The column headings are: "User Id", "User Type", "Last Name",
"First Name", "Department", "Phone Number", "Email Address", "Hiragana Last Name" and "Hiragana First Name", "Extension".
Office Zones can only be unassigned if the Location-Based Calling Restrictions has been authorized to the group otherwise the request will fail.
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 ="
GroupOfficeZoneGetAssignedUserListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupOfficeZoneUnassignListRequest
Abstract
no
Documentation
Unassign a list of OfficeZones from a group. Note: a new default must be provided if unassigning the current default.
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. -->
<defaultOfficeZoneName>
OfficeZoneName
</defaultOfficeZoneName>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupOfficeZoneUnassignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
officeZoneName "
type ="
OfficeZoneName
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
defaultOfficeZoneName "
type ="
OfficeZoneName
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupPasswordRulesGetRequest16
Abstract
no
Documentation
Requests the group's password rules setting that is applicable to
users within the group.
The response is either GroupPasswordRulesGetResponse16 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 ="
GroupPasswordRulesGetRequest16 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupPasswordRulesGetResponse16
Abstract
no
Documentation
Response to GroupPasswordRulesGetRequest16.
Contains the password rules applicable to users within the group.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<disallowUserId>
xs :boolean </disallowUserId>
[1]
<disallowOldPassword>
xs :boolean </disallowOldPassword>
[1]
<disallowReversedOldPassword>
xs :boolean </disallowReversedOldPassword>
[1]
<restrictMinDigits>
xs :boolean </restrictMinDigits>
[1]
<restrictMinUpperCaseLetters>
xs :boolean </restrictMinUpperCaseLetters>
[1]
<restrictMinLowerCaseLetters>
xs :boolean </restrictMinLowerCaseLetters>
[1]
<restrictMinNonAlphanumericCharacters>
xs :boolean </restrictMinNonAlphanumericCharacters>
[1]
<sendLoginDisabledNotifyEmail>
xs :boolean </sendLoginDisabledNotifyEmail>
[1]
<loginDisabledNotifyEmailAddress>
EmailAddress
</loginDisabledNotifyEmailAddress>
[0..1]
<disallowRulesModification>
xs :boolean </disallowRulesModification>
[1]
<disallowPreviousPasswords>
xs :boolean </disallowPreviousPasswords>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupPasswordRulesGetResponse16 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
disallowUserId "
type ="
xs :boolean
"/>
<
xs:element name ="
disallowOldPassword "
type ="
xs :boolean
"/>
<
xs:element name ="
disallowReversedOldPassword "
type ="
xs :boolean
"/>
<
xs:element name ="
restrictMinDigits "
type ="
xs :boolean
"/>
<
xs:element name ="
restrictMinUpperCaseLetters "
type ="
xs :boolean
"/>
<
xs:element name ="
restrictMinLowerCaseLetters "
type ="
xs :boolean
"/>
<
xs:element name ="
restrictMinNonAlphanumericCharacters "
type ="
xs :boolean
"/>
<
xs:element name ="
sendLoginDisabledNotifyEmail "
type ="
xs :boolean
"/>
<
xs:element name ="
loginDisabledNotifyEmailAddress "
type ="
EmailAddress
"
minOccurs ="
0 "/>
<
xs:element name ="
disallowRulesModification "
type ="
xs :boolean
"/>
<
xs:element name ="
disallowPreviousPasswords "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupPasswordRulesModifyRequest
Abstract
no
Documentation
Request to modify the group's password rules setting that apply to the
users within 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. -->
<disallowUserId>
xs :boolean </disallowUserId>
[0..1]
<disallowOldPassword>
xs :boolean </disallowOldPassword>
[0..1]
<disallowReversedOldPassword>
xs :boolean </disallowReversedOldPassword>
[0..1]
<restrictMinDigits>
xs :boolean </restrictMinDigits>
[0..1]
<restrictMinUpperCaseLetters>
xs :boolean </restrictMinUpperCaseLetters>
[0..1]
<restrictMinLowerCaseLetters>
xs :boolean </restrictMinLowerCaseLetters>
[0..1]
<restrictMinNonAlphanumericCharacters>
xs :boolean </restrictMinNonAlphanumericCharacters>
[0..1]
<sendLoginDisabledNotifyEmail>
xs :boolean </sendLoginDisabledNotifyEmail>
[0..1]
<loginDisabledNotifyEmailAddress>
EmailAddress
</loginDisabledNotifyEmailAddress>
[0..1]
<disallowPreviousPasswords>
xs :boolean </disallowPreviousPasswords>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupPasswordRulesModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
disallowUserId "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
disallowOldPassword "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
disallowReversedOldPassword "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
restrictMinDigits "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
restrictMinUpperCaseLetters "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
restrictMinLowerCaseLetters "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
restrictMinNonAlphanumericCharacters "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
sendLoginDisabledNotifyEmail "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
loginDisabledNotifyEmailAddress "
type ="
EmailAddress
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
disallowPreviousPasswords "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupPhoneDirectoryGetListRequest18
Abstract
no
Documentation
Request a table containing the phone directory for a group.
If the specified group is part of an enterprise, the directory
includes all users in the enterprise and all entries in the enterprise
common phone list and the common phone list of the specified group.
If the specified group is part of a service provider, the directory
includes all users in the group and all entries in the common phone
list of the specified group.
It is possible to search by various criteria to restrict the number of
rows returned.
Multiple search criteria are logically ANDed together.
The response is either GroupPhoneDirectoryGetListResponse18 or
ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<isExtendedInfoRequested>
xs :boolean </isExtendedInfoRequested>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupPhoneDirectoryGetListRequest18 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
isExtendedInfoRequested "
type ="
xs :boolean
"/>
<
xs:element name ="
searchCriteriaDn "
type ="
SearchCriteriaDn
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaYahooId "
type ="
SearchCriteriaYahooId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaUserId "
type ="
SearchCriteriaUserId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
searchCriteriaImpId "
type ="
SearchCriteriaImpId
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupPhoneDirectoryGetListResponse18
Abstract
no
Documentation
Response to GroupPhoneDirectoryGetListRequest18.
Contains a table with a row for each phone number and column headings :
"Name", "Number", "Extension", "Mobile", "Email Address",
"Department", "Hiragana Name", "Group Id", "Yahoo Id", "User Id", "IMP Id" and "Is Virtual On-Net User".
If extended directory information is requested, the following columns are also included:
"First Name", "Last Name", "Pager", "Title", "Time Zone",
"Location", "Address Line 1", "Address Line 2", "City", "State", "Zip", "Country".
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 ="
GroupPhoneDirectoryGetListResponse18 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupPolicyGetRequest20
Abstract
no
Documentation
Requests the Group's policy settings.
The response is either GroupPolicyGetResponse20 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 ="
GroupPolicyGetRequest20 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupPolicyGetResponse20
Abstract
no
Documentation
Response to GroupPolicyGetRequest20.
Contains the policy settings for the group.
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 ="
GroupPolicyGetResponse20 ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupPolicyModifyRequest
Abstract
no
Documentation
Request to modify the policies for a Group.
The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupPolicyModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupPortalPasscodeRulesGetRequest19
Abstract
no
Documentation
Requests the group's passcode rules setting.
The response is either GroupPortalPasscodeRulesGetResponse 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 ="
GroupPortalPasscodeRulesGetRequest19 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupPortalPasscodeRulesGetResponse19
Abstract
no
Documentation
Response to GroupPortalPasscodeRulesGetRequest19.
Contains the group's passcode rules setting.
The following elements are only used in AS data mode:
numberOfRepeatedDigits
disallowRepeatedPatterns
disallowContiguousSequences
numberOfAscendingDigits
numberOfDescendingDigits
numberOfPreviousPasscodes
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<disallowRepeatedDigits>
xs :boolean </disallowRepeatedDigits>
[1]
<disallowRepeatedPatterns>
xs :boolean </disallowRepeatedPatterns>
[1]
<disallowContiguousSequences>
xs :boolean </disallowContiguousSequences>
[1]
<disallowUserNumber>
xs :boolean </disallowUserNumber>
[1]
<disallowReversedUserNumber>
xs :boolean </disallowReversedUserNumber>
[1]
<disallowOldPasscode>
xs :boolean </disallowOldPasscode>
[1]
<disallowReversedOldPasscode>
xs :boolean </disallowReversedOldPasscode>
[1]
<disableLoginAfterMaxFailedLoginAttempts>
xs :boolean </disableLoginAfterMaxFailedLoginAttempts>
[1]
<expirePassword>
xs :boolean </expirePassword>
[1]
<sendLoginDisabledNotifyEmail>
xs :boolean </sendLoginDisabledNotifyEmail>
[1]
<loginDisabledNotifyEmailAddress>
EmailAddress
</loginDisabledNotifyEmailAddress>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupPortalPasscodeRulesGetResponse19 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
disallowRepeatedDigits "
type ="
xs :boolean
"/>
<
xs:element name ="
disallowRepeatedPatterns "
type ="
xs :boolean
"/>
<
xs:element name ="
disallowContiguousSequences "
type ="
xs :boolean
"/>
<
xs:element name ="
disallowUserNumber "
type ="
xs :boolean
"/>
<
xs:element name ="
disallowReversedUserNumber "
type ="
xs :boolean
"/>
<
xs:element name ="
disallowOldPasscode "
type ="
xs :boolean
"/>
<
xs:element name ="
disallowReversedOldPasscode "
type ="
xs :boolean
"/>
<
xs:element name ="
disableLoginAfterMaxFailedLoginAttempts "
type ="
xs :boolean
"/>
<
xs:element name ="
expirePassword "
type ="
xs :boolean
"/>
<
xs:element name ="
sendLoginDisabledNotifyEmail "
type ="
xs :boolean
"/>
<
xs:element name ="
loginDisabledNotifyEmailAddress "
type ="
EmailAddress
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupPortalPasscodeRulesModifyRequest
Abstract
no
Documentation
Request to modify the group's passcode rules setting.
The response is either SuccessResponse or ErrorResponse.
The following elements are only used in AS data mode:
numberOfRepeatedDigits
disallowRepeatedPatterns
disallowContiguousSequences
numberOfAscendingDigits
numberOfDescendingDigits
numberOfPreviousPasscodes
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<disallowRepeatedDigits>
xs :boolean </disallowRepeatedDigits>
[0..1]
<disallowRepeatedPatterns>
xs :boolean </disallowRepeatedPatterns>
[0..1]
<disallowContiguousSequences>
xs :boolean </disallowContiguousSequences>
[0..1]
<disallowUserNumber>
xs :boolean </disallowUserNumber>
[0..1]
<disallowReversedUserNumber>
xs :boolean </disallowReversedUserNumber>
[0..1]
<disallowOldPasscode>
xs :boolean </disallowOldPasscode>
[0..1]
<disallowReversedOldPasscode>
xs :boolean </disallowReversedOldPasscode>
[0..1]
<disableLoginAfterMaxFailedLoginAttempts>
xs :boolean </disableLoginAfterMaxFailedLoginAttempts>
[0..1]
<expirePassword>
xs :boolean </expirePassword>
[0..1]
<sendLoginDisabledNotifyEmail>
xs :boolean </sendLoginDisabledNotifyEmail>
[0..1]
<loginDisabledNotifyEmailAddress>
EmailAddress
</loginDisabledNotifyEmailAddress>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupPortalPasscodeRulesModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
disallowRepeatedDigits "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
disallowRepeatedPatterns "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
disallowContiguousSequences "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
disallowUserNumber "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
disallowReversedUserNumber "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
disallowOldPasscode "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
disallowReversedOldPasscode "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
disableLoginAfterMaxFailedLoginAttempts "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
expirePassword "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
sendLoginDisabledNotifyEmail "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
loginDisabledNotifyEmailAddress "
type ="
EmailAddress
"
nillable ="
true "
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointExternalSystemAssignListRequest
Abstract
no
Documentation
Assign a list of route point external systems to 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointExternalSystemAssignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointExternalSystemGetAssignedListRequest
Abstract
no
Documentation
Requests the list of all Route Point External Systems assigned to a group.
The response is either GroupRoutePointExternalSystemGetAssignedListResponse 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 ="
GroupRoutePointExternalSystemGetAssignedListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointExternalSystemGetAssignedListResponse
Abstract
no
Documentation
Response to the GroupRoutePointExternalSystemGetAssignedListRequest.
Contains a table of all Route Point External Systems assigned to the
group. The column headings are: "Name" and "Description".
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<externalSystemTable>
core :OCITable
</externalSystemTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointExternalSystemGetAssignedListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointExternalSystemGetAssignedRoutePointListRequest
Abstract
no
Documentation
Request a list of route points within in a group that have a given external system assigned.
The response is either GroupRoutePointExternalSystemGetAssignedRoutePointListResponse 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 ="
GroupRoutePointExternalSystemGetAssignedRoutePointListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutePointExternalSystemGetAssignedRoutePointListResponse
Abstract
no
Documentation
Response to the GroupRoutePointExternalSystemGetAssignedRoutePointListRequest.
Contains a table with column headings:
"Service User Id", "Name", "Video", "Phone Number", "Extension", "Department".
The column values for "Video" 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 ="
GroupRoutePointExternalSystemGetAssignedRoutePointListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutePointExternalSystemUnassignListRequest
Abstract
no
Documentation
Unassign a list of route point external systems 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutePointExternalSystemUnassignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutingProfileGetRequest
Abstract
no
Documentation
Request the routing profile for the group.
The response is either a GroupRoutingProfileGetResponse 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 ="
GroupRoutingProfileGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupRoutingProfileGetResponse
Abstract
no
Documentation
Response to GroupRoutingProfileGetRequest.
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 ="
GroupRoutingProfileGetResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupRoutingProfileModifyRequest
Abstract
no
Documentation
Requests to modify the routing profile for 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupRoutingProfileModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
routingProfile "
type ="
RoutingProfile
"
nillable ="
true "
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupScheduleAddEventRequest
Abstract
no
Documentation
Add an event to group schedule.
The response is either a SuccessResponse or an ErrorResponse.
The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate.
The endDate element is set to the sum of the adjusted starDate element value and the event duration.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<startDate>
xs :date </startDate>
[1]
Start Choice [1]
<allDayEvent> true </allDayEvent> [1]
End Choice
<endDate>
xs :date </endDate>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupScheduleAddEventRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
eventName "
type ="
EventName
"/>
<
xs:element name ="
startDate "
type ="
xs :date
"/>
<
xs:choice >
<
xs:element name ="
allDayEvent "
type ="
xs :boolean
"
fixed ="
true "/>
<
xs:sequence >
<
xs:element name ="
startTime "
type ="
HourMinute
"/>
</
xs:sequence >
</
xs:choice >
<
xs:element name ="
endDate "
type ="
xs :date
"/>
<
xs:element name ="
recurrence "
type ="
Recurrence
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupScheduleAddRequest
Abstract
no
Documentation
Add a group schedule.
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 ="
GroupScheduleAddRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupScheduleDeleteEventListRequest
Abstract
no
Documentation
Delete a list of events from a group schedule.
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 ="
GroupScheduleDeleteEventListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
eventName "
type ="
EventName
"
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupScheduleDeleteListRequest
Abstract
no
Documentation
Delete a list of group schedule.
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 ="
GroupScheduleDeleteListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
scheduleKey "
type ="
ScheduleKey
"
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupScheduleGetEventListRequest
Abstract
no
Documentation
Get the list of events of a group schedule.
The response is either a GroupScheduleGetEventListResponse 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 ="
GroupScheduleGetEventListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupScheduleGetEventListResponse
Abstract
no
Documentation
Response to GroupScheduleGetEventListRequest.
The response contains a list of events.
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 ="
GroupScheduleGetEventListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
eventName "
type ="
EventName
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupScheduleGetEventRequest
Abstract
no
Documentation
Get an event from a group schedule.
The response is either a GroupScheduleGetEventResponse 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 ="
GroupScheduleGetEventRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
eventName "
type ="
EventName
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupScheduleGetEventResponse
Abstract
no
Documentation
Response to GroupScheduleGetEventRequest.
The response contains the event of the group schedule.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<startDate>
xs :date </startDate>
[1]
Start Choice [1]
<allDayEvent> true </allDayEvent> [1]
End Choice
<endDate>
xs :date </endDate>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupScheduleGetEventResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
startDate "
type ="
xs :date
"/>
<
xs:choice >
<
xs:element name ="
allDayEvent "
type ="
xs :boolean
"
fixed ="
true "/>
<
xs:sequence >
<
xs:element name ="
startTime "
type ="
HourMinute
"/>
</
xs:sequence >
</
xs:choice >
<
xs:element name ="
endDate "
type ="
xs :date
"/>
<
xs:element name ="
recurrence "
type ="
Recurrence
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupScheduleGetListRequest17sp1
Abstract
no
Documentation
Get the list of schedules viewable by a group. The list can be filtered by schedule type.
The response is either a GroupScheduleGetListResponse17sp1 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 ="
GroupScheduleGetListRequest17sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
scheduleType "
type ="
ScheduleType
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupScheduleGetListResponse17sp1
Abstract
no
Documentation
Response to GroupScheduleGetListRequest17sp1.
The response contains a list of group schedules. If the group belongs to an enterprise,
it also contains the schedules for the enterprise.
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 ="
GroupScheduleGetListResponse17sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
scheduleGlobalKey "
type ="
ScheduleGlobalKey
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupScheduleModifyEventRequest
Abstract
no
Documentation
Modify an event of a group schedule.
The response is either a SuccessResponse or an ErrorResponse.
The startDate element is adjusted to the first occurrence of the recurrent schedule that comes at or after the startDate.
The endDate element is set to the sum of the adjusted starDate element value and the event duration.
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<newEventName>
EventName
</newEventName>
[0..1]
<startDate>
xs :date </startDate>
[0..1]
Start Choice [0..1]
<allDayEvent> true </allDayEvent> [1]
End Choice
<endDate>
xs :date </endDate>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupScheduleModifyEventRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
eventName "
type ="
EventName
"/>
<
xs:element name ="
newEventName "
type ="
EventName
"
minOccurs ="
0 "/>
<
xs:element name ="
startDate "
type ="
xs :date
"
minOccurs ="
0 "/>
<
xs:choice minOccurs ="
0 ">
<
xs:element name ="
allDayEvent "
type ="
xs :boolean
"
fixed ="
true "/>
<
xs:sequence >
<
xs:element name ="
startTime "
type ="
HourMinute
"/>
</
xs:sequence >
</
xs:choice >
<
xs:element name ="
endDate "
type ="
xs :date
"
minOccurs ="
0 "/>
<
xs:element name ="
recurrence "
type ="
Recurrence
"
minOccurs ="
0 "
nillable ="
true "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupScheduleModifyRequest
Abstract
no
Documentation
Modify a group schedule.
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 ="
GroupScheduleModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
newScheduleName "
type ="
ScheduleName
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupServiceAssignListRequest
Abstract
no
Documentation
Assign one or more group services to 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. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupServiceAssignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
serviceName "
type ="
GroupService
"
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupServiceGetAuthorizationListRequest
Abstract
no
Documentation
Requests the group's service authorization status.
The response is either GroupServiceGetAuthorizationListResponse 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 ="
GroupServiceGetAuthorizationListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupServiceGetAuthorizationListResponse
Abstract
no
Documentation
Response to GroupServiceGetAuthorizationListRequest.
Contains three tables, one for the service packs, one for the group services, and one for
the user services.
The user table has the following column headings:
"Service Name", "Authorized", "Assigned", "Limited", "Quantity", "Usage", "Licensed", "Allowed", "User Assignable", "Group Service Assignable".
The group service table has the following column headings:
"Service Name", "Authorized", "Assigned", "Limited", "Quantity", "Usage", "Licensed", "Allowed".
The service pack table's column headings are:
"Service Pack Name", "Authorized", "Assigned", "Limited", "Allocated", "Allowed", "Usage", "Description".
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<servicePacksAuthorizationTable>
core :OCITable
</servicePacksAuthorizationTable>
[1]
<groupServicesAuthorizationTable>
core :OCITable
</groupServicesAuthorizationTable>
[1]
<userServicesAuthorizationTable>
core :OCITable
</userServicesAuthorizationTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupServiceGetAuthorizationListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
servicePacksAuthorizationTable "
type ="
core :OCITable
"/>
<
xs:element name ="
groupServicesAuthorizationTable "
type ="
core :OCITable
"/>
<
xs:element name ="
userServicesAuthorizationTable "
type ="
core :OCITable
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupServiceGetAuthorizedListRequest
Abstract
no
Documentation
Requests the list of services and service packs authorized to a group.
The response is either GroupServiceGetAuthorizedListResponse 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 ="
GroupServiceGetAuthorizedListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupServiceGetAuthorizedListResponse
Abstract
no
Documentation
Response to GroupServiceGetAuthorizedListRequest.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<userServiceName>
UserService
</userServiceName>
[0..*]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupServiceGetAuthorizedListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
servicePackName "
type ="
ServicePackName
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
groupServiceName "
type ="
GroupService
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
userServiceName "
type ="
UserService
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupServiceIsAssignedRequest
Abstract
no
Documentation
Request to determine if a GroupService is assigned to the group.
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 ="
GroupServiceIsAssignedRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupServiceIsAssignedResponse
Abstract
no
Documentation
Returns true if the GroupService is assigned, otherwise false.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<isAssigned>
xs :boolean </isAssigned>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupServiceIsAssignedResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
isAssigned "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupServiceModifyAuthorizationListRequest
Abstract
no
Documentation
Requests to change the group's service authorization status.
The boolean flags are used to authorize or unauthorize services and packs.
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 ="
GroupServiceModifyAuthorizationListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupServiceUnassignListRequest
Abstract
no
Documentation
Unassign one or more of the group's assigned services.
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 ="
GroupServiceUnassignListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
serviceName "
type ="
GroupService
"
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlGetAvailableDeviceListRequest
Abstract
no
Documentation
Request to get the list of devices can be assigned to session admission control group for the group.
The response is either an GroupSessionAdmissionControlGetAvailableDeviceListResponse 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 ="
GroupSessionAdmissionControlGetAvailableDeviceListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupSessionAdmissionControlGetAvailableDeviceListResponse
Abstract
no
Documentation
Response to GroupSessionAdmissionControlGetAvailableDeviceListRequest.
Contains a table of devices can be assigned to session admission control group in the group.
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 ="
GroupSessionAdmissionControlGetAvailableDeviceListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
accessDevice "
type ="
AccessDevice
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlGetRequest
Abstract
no
Documentation
Get the session admission control capacity for the group.
The response is either a GroupSessionAdmissionControlGetResponse 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 ="
GroupSessionAdmissionControlGetRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupSessionAdmissionControlGetResponse
Abstract
no
Documentation
Response to the GroupSessionAdmissionControlGetRequest.
The response contains the session admission control capacity allocated for the group.
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. -->
<restrictAggregateSessions>
xs :boolean </restrictAggregateSessions>
[1]
<maxUserOriginatingSessions>
NonNegativeInt
</maxUserOriginatingSessions>
[0..1]
<maxUserTerminatingSessions>
NonNegativeInt
</maxUserTerminatingSessions>
[0..1]
<countIntraGroupSessions>
xs :boolean </countIntraGroupSessions>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupSessionAdmissionControlGetResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
restrictAggregateSessions "
type ="
xs :boolean
"/>
<
xs:element name ="
maxSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
maxUserOriginatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
maxUserTerminatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
countIntraGroupSessions "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlGroupAddDeviceListRequest
Abstract
no
Documentation
Request to add one ore more devices to a group level session admission control group.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupSessionAdmissionControlGroupAddDeviceListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
devices "
type ="
AccessDevice
"
minOccurs ="
1 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlGroupAddRequest19sp1
Abstract
no
Documentation
Request to add a session admission control group for the group.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<maxUserOriginatingSessions>
NonNegativeInt
</maxUserOriginatingSessions>
[0..1]
<maxUserTerminatingSessions>
NonNegativeInt
</maxUserTerminatingSessions>
[0..1]
<reservedUserOriginatingSessions>
NonNegativeInt
</reservedUserOriginatingSessions>
[0..1]
<reservedUserTerminatingSessions>
NonNegativeInt
</reservedUserTerminatingSessions>
[0..1]
<becomeDefaultGroup>
xs :boolean </becomeDefaultGroup>
[1]
<countIntraSACGroupSessions>
xs :boolean </countIntraSACGroupSessions>
[1]
<blockEmergencyAndRepairCallsDueToSACLimits>
xs :boolean </blockEmergencyAndRepairCallsDueToSACLimits>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupSessionAdmissionControlGroupAddRequest19sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
maxUserOriginatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
maxUserTerminatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
reservedUserOriginatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
reservedUserTerminatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
becomeDefaultGroup "
type ="
xs :boolean
"/>
<
xs:element name ="
countIntraSACGroupSessions "
type ="
xs :boolean
"/>
<
xs:element name ="
devices "
type ="
AccessDevice
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
blockEmergencyAndRepairCallsDueToSACLimits "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlGroupDeleteDeviceListRequest
Abstract
no
Documentation
Request to delete one or more devices from a group level session admission control group.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupSessionAdmissionControlGroupDeleteDeviceListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
devices "
type ="
AccessDevice
"
minOccurs ="
1 "
maxOccurs ="
unbounded "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlGroupDeleteListRequest
Abstract
no
Documentation
Request to delete one or more session admission control groups for the group.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
</...>
Schema Component Representation
<
xs:complexType name ="
GroupSessionAdmissionControlGroupDeleteListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlGroupGetListRequest
Abstract
no
Documentation
Request to get the list of session admission control group for the group.
The response is either a GroupSessionAdmissionControlGroupGetListResponse 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 ="
GroupSessionAdmissionControlGroupGetListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupSessionAdmissionControlGroupGetListResponse
Abstract
no
Documentation
Response to GroupSessionAdmissionControlGroupGetListRequest.
Contains a table of session admission control group configured in the group.
The column headings are: "Name", "Is Default", "Maximum Sessions", "Maximum Originating Sessions", "Maximum Terminating Sessions".
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. -->
<sessionAdmissionControlGroupTable>
core :OCITable
</sessionAdmissionControlGroupTable>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupSessionAdmissionControlGroupGetListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
sessionAdmissionControlGroupTable "
type ="
core :OCITable
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlGroupGetRequest19sp1
Abstract
no
Documentation
Request to get a session admission control group for the group.
The response is either a GroupSessionAdmissionControlGroupGetResponse19sp1 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 ="
GroupSessionAdmissionControlGroupGetRequest19sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupSessionAdmissionControlGroupGetResponse19sp1
Abstract
no
Documentation
Response to GroupSessionAdmissionControlGroupGetRequest19sp1.
Returns the profile information for the session admission control group.
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. -->
<maxUserOriginatingSessions>
NonNegativeInt
</maxUserOriginatingSessions>
[0..1]
<maxUserTerminatingSessions>
NonNegativeInt
</maxUserTerminatingSessions>
[0..1]
<reservedUserOriginatingSessions>
NonNegativeInt
</reservedUserOriginatingSessions>
[0..1]
<reservedUserTerminatingSessions>
NonNegativeInt
</reservedUserTerminatingSessions>
[0..1]
<defaultGroup>
xs :boolean </defaultGroup>
[1]
<countIntraSACGroupSessions>
xs :boolean </countIntraSACGroupSessions>
[1]
<blockEmergencyAndRepairCallsDueToSACLimits>
xs :boolean </blockEmergencyAndRepairCallsDueToSACLimits>
[1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupSessionAdmissionControlGroupGetResponse19sp1 ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
maxUserOriginatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
maxUserTerminatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
reservedUserOriginatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
reservedUserTerminatingSessions "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
defaultGroup "
type ="
xs :boolean
"/>
<
xs:element name ="
countIntraSACGroupSessions "
type ="
xs :boolean
"/>
<
xs:element name ="
devices "
type ="
AccessDevice
"
minOccurs ="
0 "
maxOccurs ="
unbounded "/>
<
xs:element name ="
blockEmergencyAndRepairCallsDueToSACLimits "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlGroupModifyRequest
Abstract
no
Documentation
Request to modify a session admission control group for the group.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<maxUserOriginatingSessions>
NonNegativeInt
</maxUserOriginatingSessions>
[0..1]
<maxUserTerminatingSessions>
NonNegativeInt
</maxUserTerminatingSessions>
[0..1]
<reservedUserOriginatingSessions>
NonNegativeInt
</reservedUserOriginatingSessions>
[0..1]
<reservedUserTerminatingSessions>
NonNegativeInt
</reservedUserTerminatingSessions>
[0..1]
<becomeDefaultGroup>
xs :boolean </becomeDefaultGroup>
[0..1]
<countIntraSACGroupSessions>
xs :boolean </countIntraSACGroupSessions>
[0..1]
<blockEmergencyAndRepairCallsDueToSACLimits>
xs :boolean </blockEmergencyAndRepairCallsDueToSACLimits>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupSessionAdmissionControlGroupModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
maxUserOriginatingSessions "
type ="
NonNegativeInt
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
maxUserTerminatingSessions "
type ="
NonNegativeInt
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
reservedSession "
type ="
NonNegativeInt
"
minOccurs ="
0 "/>
<
xs:element name ="
reservedUserOriginatingSessions "
type ="
NonNegativeInt
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
reservedUserTerminatingSessions "
type ="
NonNegativeInt
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
becomeDefaultGroup "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
countIntraSACGroupSessions "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
blockEmergencyAndRepairCallsDueToSACLimits "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupSessionAdmissionControlModifyRequest
Abstract
no
Documentation
Request to modify session admission control capacity for the group.
The response is either a SuccessResponse or an ErrorResponse.
Application Data
<asDataModeSupported> true
</asDataModeSupported>
<hssDataModeSupported> false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- '
OCICommand
' super type was not found in this schema. Some elements and attributes may be missing. -->
<restrictAggregateSessions>
xs :boolean </restrictAggregateSessions>
[0..1]
<maxUserOriginatingSessions>
NonNegativeInt
</maxUserOriginatingSessions>
[0..1]
<maxUserTerminatingSessions>
NonNegativeInt
</maxUserTerminatingSessions>
[0..1]
<countIntraGroupSessions>
xs :boolean </countIntraGroupSessions>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
GroupSessionAdmissionControlModifyRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
<
xs:element name ="
restrictAggregateSessions "
type ="
xs :boolean
"
minOccurs ="
0 "/>
<
xs:element name ="
maxSessions "
type ="
NonNegativeInt
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
maxUserOriginatingSessions "
type ="
NonNegativeInt
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
maxUserTerminatingSessions "
type ="
NonNegativeInt
"
nillable ="
true "
minOccurs ="
0 "/>
<
xs:element name ="
countIntraGroupSessions "
type ="
xs :boolean
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupShInterfaceGetUserListRequest
Abstract
no
Documentation
Returns a list of all Public User Identities and associated data in a group.
The response is either a GroupShInterfaceGetUserListResponse 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 ="
GroupShInterfaceGetUserListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupShInterfaceGetUserListResponse
Abstract
no
Documentation
Response to the GroupShInterfaceGetUserListRequest.
The response contains the Sh Non Transparent data and associated Public User Identity
information for every Public User Identity in the group.
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 ="
GroupShInterfaceGetUserListResponse ">
<
xs:complexContent >
</
xs:complexContent >
</
xs:complexType >
Parent type:
core :OCIRequest
(derivation method: extension)
Sub-types:
None
Name
GroupTrunkGroupGetAvailableDetailListRequest
Abstract
no
Documentation
Requests the list of available trunk groups within a group.
The response is either GroupTrunkGroupGetAvailableDetailListResponse 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 ="
GroupTrunkGroupGetAvailableDetailListRequest ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIRequest
">
<
xs:sequence >
<
xs:element name ="
groupId "
type ="
GroupId
"/>
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Name
GroupTrunkGroupGetAvailableDetailListResponse
Abstract
no
Documentation
Response to GroupTrunkGroupGetAvailableDetailListRequest.
XML Instance Representation
<...>
<!-- '
OCIResponse
' super type was not found in this schema. Some elements and attributes may be missing. -->
<trunkGroup>
[0..*]
<staticRegistrationCapable>
xs :boolean </staticRegistrationCapable>
[1]
<useDomain>
xs :boolean </useDomain>
[1]
</trunkGroup>
</...>
Schema Component Representation
<
xs:complexType name ="
GroupTrunkGroupGetAvailableDetailListResponse ">
<
xs:complexContent >
<
xs:extension base ="
core :OCIDataResponse
">
<
xs:sequence >
<
xs:element name ="
trunkGroup "
minOccurs ="
0 "
maxOccurs ="
unbounded ">
<
xs:complexType >
<
xs:sequence >
<
xs:element name ="
staticRegistrationCapable "
type ="
xs :boolean
"/>
<
xs:element name ="
useDomain "
type ="
xs :boolean
"/>
</
xs:sequence >
</
xs:complexType >
</
xs:element >
</
xs:sequence >
</
xs:extension >
</
xs:complexContent >
</
xs:complexType >
Parent type:
None
Sub-types:
None
Name
ReplacementCustomContactDirectoryEntryList
Abstract
no
Documentation
A list of userIds and/or Virtual On-Net user DNs that replaces a previously configured list.
By convention, an element of this type may be set nill to clear the list.
Schema Component Representation
<
xs:complexType name ="
ReplacementCustomContactDirectoryEntryList ">
<
xs:sequence >
</
xs:sequence >
</
xs:complexType >
Parent type:
None
Sub-types:
None
Name
ShInterfaceUserListEntry
Abstract
no
Documentation
ShInterface User List Entry.
XML Instance Representation
<...>
<SCSCFName>
SIPURI
</SCSCFName>
[0..1]
</...>
Schema Component Representation
<
xs:complexType name ="
ShInterfaceUserListEntry ">
<
xs:sequence >
<
xs:element name ="
userId "
type ="
UserId
"/>
<
xs:element name ="
userType "
type ="
UserType
"/>
<
xs:element name ="
SCSCFName "
type ="
SIPURI
"
minOccurs ="
0 "/>
</
xs:sequence >
</
xs:complexType >
Parent type:
xs :token (derivation method: restriction)
Sub-types:
None
Name
DepartmentCallingLineIdName
Content
Documentation
Department calling line ID name.
Schema Component Representation
<
xs:simpleType name ="
DepartmentCallingLineIdName ">
<
xs:restriction base ="
xs :token
">
<xs:minLength value ="1 "/>
<xs:maxLength value ="80 "/>
</
xs:restriction >
</
xs:simpleType >
Parent type:
xs :token (derivation method: restriction)
Sub-types:
None
Name
GroupDigitCollectionSettingLevel
Content
value comes from list: {'System'|'Service Provider'|'Group'}
Documentation
Choices for the group digit collection feature to decide which type of settings to use.
Schema Component Representation
<
xs:simpleType name ="
GroupDigitCollectionSettingLevel ">
<
xs:restriction base ="
xs :token
">
<xs:enumeration value ="System "/>
<xs:enumeration value ="Service Provider "/>
<xs:enumeration value ="Group "/>
</
xs:restriction >
</
xs:simpleType >
Parent type:
xs :token (derivation method: restriction)
Sub-types:
None
Name
GroupFeatureAccessCodeLevel
Content
value comes from list: {'Service Provider'|'Group'}
Documentation
Feature Access Code Level defining group policy how Feature Access Codes will be used by a group.
Schema Component Representation
<
xs:simpleType name ="
GroupFeatureAccessCodeLevel ">
<
xs:restriction base ="
xs :token
">
<xs:enumeration value ="Service Provider "/>
<xs:enumeration value ="Group "/>
</
xs:restriction >
</
xs:simpleType >
Parent type:
xs :int (derivation method: restriction)
Sub-types:
None
Name
GroupUserLimit
Content
Documentation
Configured maximum number of users in a group.
Application Data
Schema Component Representation
<
xs:simpleType name ="
GroupUserLimit ">
<
xs:restriction base ="
xs :int
">
<xs:minInclusive value ="1 "/>
<xs:maxInclusive value ="999999 "/>
</
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 .