XML Schema Documentation

Table of Contents

top

Schema Document Properties

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

Declared Namespaces

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

Global Definitions

Complex Type: AutoAttendantAddMenu20

Parent type: None
Sub-types: None
Name AutoAttendantAddMenu20
Abstract no
Documentation The configuration of the automated receptionist greeting prompt and dialing menu to be used during after business hours.
XML Instance Representation
<...>
<announcementSelection> AnnouncementSelection </announcementSelection> [1]
<audioFile> AnnouncementFileLevelKey </audioFile> [0..1]
<videoFile> AnnouncementFileLevelKey </videoFile> [0..1]
<enableFirstMenuLevelExtensionDialing> xs:boolean </enableFirstMenuLevelExtensionDialing> [1]
<keyConfiguration> AutoAttendantKeyConfiguration20 </keyConfiguration> [0..12]
</...>
Schema Component Representation
<xs:complexType name="AutoAttendantAddMenu20">
<xs:sequence>
<xs:element name="announcementSelection" type=" AnnouncementSelection "/>
<xs:element name="audioFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="videoFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="enableFirstMenuLevelExtensionDialing" type=" xs:boolean "/>
<xs:element name="keyConfiguration" type=" AutoAttendantKeyConfiguration20 " minOccurs="0" maxOccurs="12"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AutoAttendantKeyConfiguration20

Parent type: None
Sub-types: None
Name AutoAttendantKeyConfiguration20
Abstract no
Documentation The configuration of a key for Auto Attendant.
XML Instance Representation
<...>
<key> AutoAttendantMenuKey </key> [1]
<entry> AutoAttendantKeyConfigurationEntry20 </entry> [1]
</...>
Schema Component Representation
<xs:complexType name="AutoAttendantKeyConfiguration20">
<xs:sequence>
<xs:element name="key" type=" AutoAttendantMenuKey "/>
<xs:element name="entry" type=" AutoAttendantKeyConfigurationEntry20 "/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AutoAttendantKeyConfigurationEntry20

Parent type: None
Sub-types: None
Name AutoAttendantKeyConfigurationEntry20
Abstract no
Documentation The configuration entry of a key for Auto Attendant. The following data elements are only used in AS data mode: audioFile videoFile submenuId The following data elements are only valid for Standard Auto Attendants: submenuId
XML Instance Representation
<...>
<description> AutoAttendantMenuKeyDescription </description> [0..1]
<action> AutoAttendantKeyAction </action> [1]
<phoneNumber> OutgoingDN </phoneNumber> [0..1]
<audioFile> AnnouncementFileLevelKey </audioFile> [0..1]
<videoFile> AnnouncementFileLevelKey </videoFile> [0..1]
<submenuId> AutoAttendantSubmenuId </submenuId> [0..1]
</...>
Schema Component Representation
<xs:complexType name="AutoAttendantKeyConfigurationEntry20">
<xs:sequence>
<xs:element name="description" type=" AutoAttendantMenuKeyDescription " minOccurs="0"/>
<xs:element name="action" type=" AutoAttendantKeyAction "/>
<xs:element name="phoneNumber" type=" OutgoingDN " minOccurs="0"/>
<xs:element name="audioFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="videoFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="submenuId" type=" AutoAttendantSubmenuId " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AutoAttendantKeyConfigurationModifyEntry20

Parent type: None
Sub-types: None
Name AutoAttendantKeyConfigurationModifyEntry20
Abstract no
Documentation The modify configuration entry of a key for Auto Attendant. The following data elements are only used in AS data mode: audioFile videoFile submenuId The following data elements are only valid for Standard Auto Attendants: submenuId
XML Instance Representation
<...>
<description> AutoAttendantMenuKeyDescription </description> [0..1]
<action> AutoAttendantKeyAction </action> [1]
<phoneNumber> OutgoingDN </phoneNumber> [0..1]
<audioFile> AnnouncementFileLevelKey </audioFile> [0..1]
<videoFile> AnnouncementFileLevelKey </videoFile> [0..1]
<submenuId> AutoAttendantSubmenuId </submenuId> [0..1]
</...>
Schema Component Representation
<xs:complexType name="AutoAttendantKeyConfigurationModifyEntry20">
<xs:sequence>
<xs:element name="description" type=" AutoAttendantMenuKeyDescription " nillable="true" minOccurs="0"/>
<xs:element name="action" type=" AutoAttendantKeyAction "/>
<xs:element name="phoneNumber" type=" OutgoingDN " nillable="true" minOccurs="0"/>
<xs:element name="audioFile" type=" AnnouncementFileLevelKey " minOccurs="0" nillable="true"/>
<xs:element name="videoFile" type=" AnnouncementFileLevelKey " minOccurs="0" nillable="true"/>
<xs:element name="submenuId" type=" AutoAttendantSubmenuId " nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AutoAttendantKeyConfigurationReadEntry20

Parent type: None
Sub-types: None
Name AutoAttendantKeyConfigurationReadEntry20
Abstract no
Documentation The read configuration entry of a key for Auto Attendant. The following data elements are only used in AS data mode: submenuId The following data elements are only valid for Standard Auto Attendants: submenuId
XML Instance Representation
<...>
<description> AutoAttendantMenuKeyDescription </description> [0..1]
<action> AutoAttendantKeyAction </action> [1]
<phoneNumber> OutgoingDN </phoneNumber> [0..1]
<audioFile> AnnouncementFileLevelKey </audioFile> [0..1]
<videoFile> AnnouncementFileLevelKey </videoFile> [0..1]
<submenuId> AutoAttendantSubmenuId </submenuId> [0..1]
</...>
Schema Component Representation
<xs:complexType name="AutoAttendantKeyConfigurationReadEntry20">
<xs:sequence>
<xs:element name="description" type=" AutoAttendantMenuKeyDescription " minOccurs="0"/>
<xs:element name="action" type=" AutoAttendantKeyAction "/>
<xs:element name="phoneNumber" type=" OutgoingDN " minOccurs="0"/>
<xs:element name="audioFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="videoFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="submenuId" type=" AutoAttendantSubmenuId " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AutoAttendantKeyModifyConfiguration20

Parent type: None
Sub-types: None
Name AutoAttendantKeyModifyConfiguration20
Abstract no
Documentation The modify configuration of a key for Auto Attendant.
XML Instance Representation
<...>
<key> AutoAttendantMenuKey </key> [1]
<entry> AutoAttendantKeyConfigurationModifyEntry20 </entry> [1]
</...>
Schema Component Representation
<xs:complexType name="AutoAttendantKeyModifyConfiguration20">
<xs:sequence>
<xs:element name="key" type=" AutoAttendantMenuKey "/>
<xs:element name="entry" type=" AutoAttendantKeyConfigurationModifyEntry20 " nillable="true"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AutoAttendantKeyReadConfiguration20

Parent type: None
Sub-types: None
Name AutoAttendantKeyReadConfiguration20
Abstract no
Documentation The read configuration of a key for Auto Attendant.
XML Instance Representation
<...>
<key> AutoAttendantMenuKey </key> [1]
<entry> AutoAttendantKeyConfigurationReadEntry20 </entry> [1]
</...>
Schema Component Representation
<xs:complexType name="AutoAttendantKeyReadConfiguration20">
<xs:sequence>
<xs:element name="key" type=" AutoAttendantMenuKey "/>
<xs:element name="entry" type=" AutoAttendantKeyConfigurationReadEntry20 "/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AutoAttendantModifyMenu20

Parent type: None
Sub-types: None
Name AutoAttendantModifyMenu20
Abstract no
Documentation The configuration of the automated receptionist greeting prompt and dialing menu to be used during business hours. It is used when modifying an Auto Attendant group.
XML Instance Representation
<...>
<announcementSelection> AnnouncementSelection </announcementSelection> [0..1]
<audioFile> AnnouncementFileLevelKey </audioFile> [0..1]
<videoFile> AnnouncementFileLevelKey </videoFile> [0..1]
<enableFirstMenuLevelExtensionDialing> xs:boolean </enableFirstMenuLevelExtensionDialing> [0..1]
<keyConfiguration> AutoAttendantKeyModifyConfiguration20 </keyConfiguration> [0..12]
</...>
Schema Component Representation
<xs:complexType name="AutoAttendantModifyMenu20">
<xs:sequence>
<xs:element name="announcementSelection" type=" AnnouncementSelection " minOccurs="0"/>
<xs:element name="audioFile" type=" AnnouncementFileLevelKey " minOccurs="0" nillable="true"/>
<xs:element name="videoFile" type=" AnnouncementFileLevelKey " minOccurs="0" nillable="true"/>
<xs:element name="enableFirstMenuLevelExtensionDialing" type=" xs:boolean " minOccurs="0"/>
<xs:element name="keyConfiguration" type=" AutoAttendantKeyModifyConfiguration20 " minOccurs="0" maxOccurs="12"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: AutoAttendantReadMenu20

Parent type: None
Sub-types: None
Name AutoAttendantReadMenu20
Abstract no
Documentation The configuration of the automated receptionist greeting prompt and dialing menu to be used during after business hours.
XML Instance Representation
<...>
<announcementSelection> AnnouncementSelection </announcementSelection> [1]
<audioFile> AnnouncementFileLevelKey </audioFile> [0..1]
<videoFile> AnnouncementFileLevelKey </videoFile> [0..1]
<enableFirstMenuLevelExtensionDialing> xs:boolean </enableFirstMenuLevelExtensionDialing> [1]
<keyConfiguration> AutoAttendantKeyReadConfiguration20 </keyConfiguration> [0..12]
</...>
Schema Component Representation
<xs:complexType name="AutoAttendantReadMenu20">
<xs:sequence>
<xs:element name="announcementSelection" type=" AnnouncementSelection "/>
<xs:element name="audioFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="videoFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="enableFirstMenuLevelExtensionDialing" type=" xs:boolean "/>
<xs:element name="keyConfiguration" type=" AutoAttendantKeyReadConfiguration20 " minOccurs="0" maxOccurs="12"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: GroupAutoAttendantAddInstanceRequest20

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantAddInstanceRequest20
Abstract no
Documentation Add a Auto Attendant instance to a group. The domain is required in the serviceUserId. Only Group and Enterprise level schedules are accepted. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode: type, use AutoAttendantType.BASIC in HSS mode. holidayMenu. The following elements are only valid for Standard Auto Attendants: holidayMenu
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. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<groupId> GroupId </groupId> [1]
<serviceUserId> UserId </serviceUserId> [1]
<serviceInstanceProfile> ServiceInstanceAddProfile </serviceInstanceProfile> [1]
<type> AutoAttendantType </type> [1]
<firstDigitTimeoutSeconds> FirstDigitTimoutSeconds </firstDigitTimeoutSeconds> [1]
<enableVideo> xs:boolean </enableVideo> [1]
<businessHours> TimeSchedule </businessHours> [0..1]
<holidaySchedule> HolidaySchedule </holidaySchedule> [0..1]
<extensionDialingScope> AutoAttendantDialingScope </extensionDialingScope> [1]
<nameDialingScope> AutoAttendantDialingScope </nameDialingScope> [1]
<nameDialingEntries> AutoAttendantNameDialingEntry </nameDialingEntries> [1]
<businessHoursMenu> AutoAttendantAddMenu20 </businessHoursMenu> [0..1]
<afterHoursMenu> AutoAttendantAddMenu20 </afterHoursMenu> [0..1]
<holidayMenu> AutoAttendantAddMenu20 </holidayMenu> [0..1]
<networkClassOfService> NetworkClassOfServiceName </networkClassOfService> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantAddInstanceRequest20">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="groupId" type=" GroupId "/>
<xs:element name="serviceUserId" type=" UserId "/>
<xs:element name="serviceInstanceProfile" type=" ServiceInstanceAddProfile "/>
<xs:element name="type" type=" AutoAttendantType "/>
<xs:element name="firstDigitTimeoutSeconds" type=" FirstDigitTimoutSeconds "/>
<xs:element name="enableVideo" type=" xs:boolean "/>
<xs:element name="businessHours" type=" TimeSchedule " minOccurs="0"/>
<xs:element name="holidaySchedule" type=" HolidaySchedule " minOccurs="0"/>
<xs:element name="extensionDialingScope" type=" AutoAttendantDialingScope "/>
<xs:element name="nameDialingScope" type=" AutoAttendantDialingScope "/>
<xs:element name="nameDialingEntries" type=" AutoAttendantNameDialingEntry "/>
<xs:element name="businessHoursMenu" type=" AutoAttendantAddMenu20 " minOccurs="0"/>
<xs:element name="afterHoursMenu" type=" AutoAttendantAddMenu20 " minOccurs="0"/>
<xs:element name="holidayMenu" type=" AutoAttendantAddMenu20 " minOccurs="0"/>
<xs:element name="networkClassOfService" type=" NetworkClassOfServiceName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantDeleteInstanceRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantDeleteInstanceRequest
Abstract no
Documentation Delete a Auto Attendant instance from a group. The response is either SuccessResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceUserId> UserId </serviceUserId> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantDeleteInstanceRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceUserId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantGetInstanceListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantGetInstanceListRequest
Abstract no
Documentation Get a list of Auto Attendant instances within a group. The response is either GroupAutoAttendantGetInstanceListResponse or ErrorResponse. It is possible to get the instances within a specified department.
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. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<groupId> GroupId </groupId> [1]
<groupDepartmentName> DepartmentName </groupDepartmentName> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantGetInstanceListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="groupId" type=" GroupId "/>
<xs:element name="groupDepartmentName" type=" DepartmentName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantGetInstanceListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantGetInstanceListResponse
Abstract no
Documentation Response to the GroupAutoAttendantGetInstanceListRequest. Contains a table with column headings: "Service User Id", "Name", "Video", "Phone Number", "Extension", "Department", "Is Active", "Type". The column values for "Video" and "Is Active" can either be true, or false. The column values for "Type" can either be Basic or Standard. In HSS Mode the value for the "Type" column will always be populated with Basic.
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. -->
<autoAttendantTable> core:OCITable </autoAttendantTable> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantGetInstanceListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="autoAttendantTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantGetInstanceRequest20

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantGetInstanceRequest20
Abstract no
Documentation Request to get all the information of a Auto Attendant instance. The response is either GroupAutoAttendantGetInstanceResponse20 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. -->
<serviceUserId> UserId </serviceUserId> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantGetInstanceRequest20">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceUserId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantGetInstanceResponse20

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantGetInstanceResponse20
Abstract no
Documentation Response to GroupAutoAttendantGetInstanceRequest20. Contains the service profile information. The following elements are only used in AS data mode: type, use AutoAttendantType.BASIC in HSS mode. holidayMenu. The following elements are only valid for Standard Auto Attendants: holidayMenu
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. -->
<serviceInstanceProfile> ServiceInstanceReadProfile19sp1 </serviceInstanceProfile> [1]
<type> AutoAttendantType </type> [1]
<firstDigitTimeoutSeconds> FirstDigitTimoutSeconds </firstDigitTimeoutSeconds> [1]
<enableVideo> xs:boolean </enableVideo> [1]
<businessHours> TimeSchedule </businessHours> [0..1]
<holidaySchedule> HolidaySchedule </holidaySchedule> [0..1]
<extensionDialingScope> AutoAttendantDialingScope </extensionDialingScope> [1]
<nameDialingScope> AutoAttendantDialingScope </nameDialingScope> [1]
<nameDialingEntries> AutoAttendantNameDialingEntry </nameDialingEntries> [1]
<businessHoursMenu> AutoAttendantReadMenu20 </businessHoursMenu> [1]
<afterHoursMenu> AutoAttendantReadMenu20 </afterHoursMenu> [1]
<holidayMenu> AutoAttendantReadMenu20 </holidayMenu> [0..1]
<networkClassOfService> NetworkClassOfServiceName </networkClassOfService> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantGetInstanceResponse20">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="serviceInstanceProfile" type=" ServiceInstanceReadProfile19sp1 "/>
<xs:element name="type" type=" AutoAttendantType "/>
<xs:element name="firstDigitTimeoutSeconds" type=" FirstDigitTimoutSeconds "/>
<xs:element name="enableVideo" type=" xs:boolean "/>
<xs:element name="businessHours" type=" TimeSchedule " minOccurs="0"/>
<xs:element name="holidaySchedule" type=" HolidaySchedule " minOccurs="0"/>
<xs:element name="extensionDialingScope" type=" AutoAttendantDialingScope "/>
<xs:element name="nameDialingScope" type=" AutoAttendantDialingScope "/>
<xs:element name="nameDialingEntries" type=" AutoAttendantNameDialingEntry "/>
<xs:element name="businessHoursMenu" type=" AutoAttendantReadMenu20 "/>
<xs:element name="afterHoursMenu" type=" AutoAttendantReadMenu20 "/>
<xs:element name="holidayMenu" type=" AutoAttendantReadMenu20 " minOccurs="0"/>
<xs:element name="networkClassOfService" type=" NetworkClassOfServiceName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantModifyActiveInstanceListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantModifyActiveInstanceListRequest
Abstract no
Documentation Request to set the active status of Auto Attendant instances. The response is either SuccessResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceActivation> ServiceActivation </serviceActivation> [0..*]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantModifyActiveInstanceListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceActivation" type=" ServiceActivation " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantModifyInstanceRequest20

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantModifyInstanceRequest20
Abstract no
Documentation Request to modify an Auto Attendant instance. Only Group and Enterprise level schedules are accepted. The response is either SuccessResponse or ErrorResponse. The following elements are only used in AS data mode: holidayMenu. The following elements are only valid for Standard Auto Attendants: holidayMenu
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. -->
<serviceUserId> UserId </serviceUserId> [1]
<serviceInstanceProfile> ServiceInstanceModifyProfile </serviceInstanceProfile> [0..1]
<firstDigitTimeoutSeconds> FirstDigitTimoutSeconds </firstDigitTimeoutSeconds> [0..1]
<enableVideo> xs:boolean </enableVideo> [0..1]
<businessHours> TimeSchedule </businessHours> [0..1]
<holidaySchedule> HolidaySchedule </holidaySchedule> [0..1]
<extensionDialingScope> AutoAttendantDialingScope </extensionDialingScope> [0..1]
<nameDialingScope> AutoAttendantDialingScope </nameDialingScope> [0..1]
<nameDialingEntries> AutoAttendantNameDialingEntry </nameDialingEntries> [0..1]
<businessHoursMenu> AutoAttendantModifyMenu20 </businessHoursMenu> [0..1]
<afterHoursMenu> AutoAttendantModifyMenu20 </afterHoursMenu> [0..1]
<holidayMenu> AutoAttendantModifyMenu20 </holidayMenu> [0..1]
<networkClassOfService> NetworkClassOfServiceName </networkClassOfService> [0..1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantModifyInstanceRequest20">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceUserId" type=" UserId "/>
<xs:element name="serviceInstanceProfile" type=" ServiceInstanceModifyProfile " minOccurs="0"/>
<xs:element name="firstDigitTimeoutSeconds" type=" FirstDigitTimoutSeconds " minOccurs="0"/>
<xs:element name="enableVideo" type=" xs:boolean " minOccurs="0"/>
<xs:element name="businessHours" type=" TimeSchedule " nillable="true" minOccurs="0"/>
<xs:element name="holidaySchedule" type=" HolidaySchedule " nillable="true" minOccurs="0"/>
<xs:element name="extensionDialingScope" type=" AutoAttendantDialingScope " minOccurs="0"/>
<xs:element name="nameDialingScope" type=" AutoAttendantDialingScope " minOccurs="0"/>
<xs:element name="nameDialingEntries" type=" AutoAttendantNameDialingEntry " minOccurs="0"/>
<xs:element name="businessHoursMenu" type=" AutoAttendantModifyMenu20 " minOccurs="0"/>
<xs:element name="afterHoursMenu" type=" AutoAttendantModifyMenu20 " minOccurs="0"/>
<xs:element name="holidayMenu" type=" AutoAttendantModifyMenu20 " minOccurs="0"/>
<xs:element name="networkClassOfService" type=" NetworkClassOfServiceName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantSubmenuAddRequest20

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantSubmenuAddRequest20
Abstract no
Documentation Request to add an Auto Attendant submenu instance. The response is either SuccessResponse or ErrorResponse. This request is only valid for Standard auto attendants.
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. -->
<serviceUserId> UserId </serviceUserId> [1]
<submenuId> AutoAttendantSubmenuId </submenuId> [1]
<announcementSelection> AnnouncementSelection </announcementSelection> [1]
<audioFile> AnnouncementFileLevelKey </audioFile> [0..1]
<videoFile> AnnouncementFileLevelKey </videoFile> [0..1]
<enableLevelExtensionDialing> xs:boolean </enableLevelExtensionDialing> [1]
<keyConfiguration> AutoAttendantKeyConfiguration20 </keyConfiguration> [0..12]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantSubmenuAddRequest20">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceUserId" type=" UserId "/>
<xs:element name="submenuId" type=" AutoAttendantSubmenuId "/>
<xs:element name="announcementSelection" type=" AnnouncementSelection "/>
<xs:element name="audioFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="videoFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="enableLevelExtensionDialing" type=" xs:boolean "/>
<xs:element name="keyConfiguration" type=" AutoAttendantKeyConfiguration20 " minOccurs="0" maxOccurs="12"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantSubmenuDeleteListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantSubmenuDeleteListRequest
Abstract no
Documentation Delete a submenu form an auto attendant. The response is either SuccessResponse or ErrorResponse. This request is only valid for Standard auto attendants.
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. -->
<serviceUserId> UserId </serviceUserId> [1]
<submenuId> AutoAttendantSubmenuId </submenuId> [1..*]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantSubmenuDeleteListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceUserId" type=" UserId "/>
<xs:element name="submenuId" type=" AutoAttendantSubmenuId " minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantSubmenuGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantSubmenuGetListRequest
Abstract no
Documentation Get a list of Auto Attendant Submenus. The response is either GroupAutoAttendantSubmenuGetListResponse or ErrorResponse. This request is only valid for Standard auto attendants.
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. -->
<serviceUserId> UserId </serviceUserId> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantSubmenuGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceUserId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantSubmenuGetListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantSubmenuGetListResponse
Abstract no
Documentation Response to the GroupAutoAttendantSubmenuGetListRequest. Contains a table with column headings: "Submenu Id" "Is Used". The column values for "Is Used" can either be true, or false.
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. -->
<submenuTable> core:OCITable </submenuTable> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantSubmenuGetListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="submenuTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantSubmenuGetRequest20

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantSubmenuGetRequest20
Abstract no
Documentation Request to get an Auto Attendant submenu instance. The response is either GroupAutoAttendantSubmenuGetResponse20 or ErrorResponse. This request is only valid for Standard auto attendants.
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. -->
<serviceUserId> UserId </serviceUserId> [1]
<submenuId> AutoAttendantSubmenuId </submenuId> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantSubmenuGetRequest20">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceUserId" type=" UserId "/>
<xs:element name="submenuId" type=" AutoAttendantSubmenuId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantSubmenuGetResponse20

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantSubmenuGetResponse20
Abstract no
Documentation Response to GroupAutoAttendantSubmenuGetRequest20. Contains AutoAttendant submenu 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. -->
<announcementSelection> AnnouncementSelection </announcementSelection> [1]
<audioFile> AnnouncementFileLevelKey </audioFile> [0..1]
<videoFile> AnnouncementFileLevelKey </videoFile> [0..1]
<enableLevelExtensionDialing> xs:boolean </enableLevelExtensionDialing> [1]
<keyConfiguration> AutoAttendantKeyReadConfiguration20 </keyConfiguration> [0..12]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantSubmenuGetResponse20">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="announcementSelection" type=" AnnouncementSelection "/>
<xs:element name="audioFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="videoFile" type=" AnnouncementFileLevelKey " minOccurs="0"/>
<xs:element name="enableLevelExtensionDialing" type=" xs:boolean "/>
<xs:element name="keyConfiguration" type=" AutoAttendantKeyReadConfiguration20 " minOccurs="0" maxOccurs="12"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantSubmenuGetUsageListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantSubmenuGetUsageListRequest
Abstract no
Documentation Get a list of Auto Attendant Business Hours Menu,After Hours Menu,Holiday Menu and Submenus that use this submenu. The response is either GroupAutoAttendantSubmenuGetUsageListResponse or ErrorResponse. This request is only valid for Standard auto attendants.
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. -->
<serviceUserId> UserId </serviceUserId> [1]
<submenuId> AutoAttendantSubmenuId </submenuId> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantSubmenuGetUsageListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceUserId" type=" UserId "/>
<xs:element name="submenuId" type=" AutoAttendantSubmenuId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantSubmenuGetUsageListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantSubmenuGetUsageListResponse
Abstract no
Documentation Response to the GroupAutoAttendantSubmenuGetUsageListRequest. Contains a table with column headings: "Type" and "Submenu ID". The "Type" Column will contain one of the following: Business Hours Menu, After Hours Menu, Holiday Menu or Submenu. The "Submenu ID" Column will be left blank when the "Type" Column contains one of the base menu types (Business Hours Menu, After Hours Menu or Holiday Menu), and will contain the Submenu ID when the "Type" Column contains type Submenu.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<submenuTable> core:OCITable </submenuTable> [1]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantSubmenuGetUsageListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="submenuTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: GroupAutoAttendantSubmenuModifyRequest20

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name GroupAutoAttendantSubmenuModifyRequest20
Abstract no
Documentation Request to modify an Auto Attendant submenu instance. The response is either SuccessResponse or ErrorResponse. This request is only valid for Standard auto attendants.
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. -->
<serviceUserId> UserId </serviceUserId> [1]
<submenuId> AutoAttendantSubmenuId </submenuId> [1]
<newSubmenuId> AutoAttendantSubmenuId </newSubmenuId> [0..1]
<announcementSelection> AnnouncementSelection </announcementSelection> [0..1]
<audioFile> AnnouncementFileLevelKey </audioFile> [0..1]
<videoFile> AnnouncementFileLevelKey </videoFile> [0..1]
<enableLevelExtensionDialing> xs:boolean </enableLevelExtensionDialing> [0..1]
<keyConfiguration> AutoAttendantKeyModifyConfiguration20 </keyConfiguration> [0..12]
</...>
Schema Component Representation
<xs:complexType name="GroupAutoAttendantSubmenuModifyRequest20">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceUserId" type=" UserId "/>
<xs:element name="submenuId" type=" AutoAttendantSubmenuId "/>
<xs:element name="newSubmenuId" type=" AutoAttendantSubmenuId " minOccurs="0"/>
<xs:element name="announcementSelection" type=" AnnouncementSelection " minOccurs="0"/>
<xs:element name="audioFile" type=" AnnouncementFileLevelKey " minOccurs="0" nillable="true"/>
<xs:element name="videoFile" type=" AnnouncementFileLevelKey " minOccurs="0" nillable="true"/>
<xs:element name="enableLevelExtensionDialing" type=" xs:boolean " minOccurs="0"/>
<xs:element name="keyConfiguration" type=" AutoAttendantKeyModifyConfiguration20 " minOccurs="0" maxOccurs="12"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: AutoAttendantType

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name AutoAttendantType
Content
  • Base XSD Type: token
  • value comes from list: {'Basic'|'Standard'}
Documentation Auto Attendant type.
Schema Component Representation
<xs:simpleType name="AutoAttendantType">
<xs:restriction base=" xs:token ">
<xs:enumeration value="Basic"/>
<xs:enumeration value="Standard"/>
</xs:restriction>
</xs:simpleType>
top

Legend

Complex Type:

Schema Component Type

AusAddress

Schema Component Name
Parent type: Address (derivation method: extension)
Sub-types:
  • QLDAddress (by restriction)
If this schema component is a type definition, its type hierarchy is shown in a gray-bordered box.
Name AusAddress
Abstract no
The table above displays the properties of this schema component.
XML Instance Representation
<... country="Australia" >
<unitNo> string </unitNo> [0..1]
<houseNo> string </houseNo> [1]
<street> string </street> [1]
Start Choice [1]
<city> string </city> [1]
<town> string </town> [1]
End Choice
<state> AusStates </state> [1]
<postcode> string <<pattern = [1-9][0-9]{3}>> </postcode> [1] ?
</...>

The XML Instance Representation table above shows the schema component's content as an XML instance.

Schema Component Representation
<complexType name="AusAddress">
<complexContent>
<extension base=" Address ">
<sequence>
<element name="state" type=" AusStates "/>
<element name="postcode">
<simpleType>
<restriction base=" string ">
<pattern value="[1-9][0-9]{3}"/>
</restriction>
</simpleType>
</element>
</sequence>
<attribute name="country" type=" string " fixed="Australia"/>
</extension>
</complexContent>
</complexType>
The Schema Component Representation table above displays the underlying XML representation of the schema component. (Annotations are not shown.)
top

Glossary

Abstract (Applies to complex type definitions and element declarations). An abstract element or complex type cannot used to validate an element instance. If there is a reference to an abstract element, only element declarations that can substitute the abstract element can be used to validate the instance. For references to abstract type definitions, only derived types can be used.

All Model Group Child elements can be provided in any order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-all.

Choice Model Group Only one from the list of child elements and model groups can be provided in instances. See: http://www.w3.org/TR/xmlschema-1/#element-choice.

Collapse Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32). Then, collapse contiguous sequences of space characters into single space character, and remove leading and trailing space characters.

Disallowed Substitutions (Applies to element declarations). If substitution is specified, then substitution group members cannot be used in place of the given element declaration to validate element instances. If derivation methods, e.g. extension, restriction, are specified, then the given element declaration will not validate element instances that have types derived from the element declaration's type using the specified derivation methods. Normally, element instances can override their declaration's type by specifying an xsi:type attribute.

Key Constraint Like Uniqueness Constraint, but additionally requires that the specified value(s) must be provided. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Key Reference Constraint Ensures that the specified value(s) must match value(s) from a Key Constraint or Uniqueness Constraint. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

Model Group Groups together element content, specifying the order in which the element content can occur and the number of times the group of element content may be repeated. See: http://www.w3.org/TR/xmlschema-1/#Model_Groups.

Nillable (Applies to element declarations). If an element declaration is nillable, instances can use the xsi:nil attribute. The xsi:nil attribute is the boolean attribute, nil, from the http://www.w3.org/2001/XMLSchema-instance namespace. If an element instance has an xsi:nil attribute set to true, it can be left empty, even though its element declaration may have required content.

Notation A notation is used to identify the format of a piece of data. Values of elements and attributes that are of type, NOTATION, must come from the names of declared notations. See: http://www.w3.org/TR/xmlschema-1/#cNotation_Declarations.

Preserve Whitespace Policy Preserve whitespaces exactly as they appear in instances.

Prohibited Derivations (Applies to type definitions). Derivation methods that cannot be used to create sub-types from a given type definition.

Prohibited Substitutions (Applies to complex type definitions). Prevents sub-types that have been derived using the specified derivation methods from validating element instances in place of the given type definition.

Replace Whitespace Policy Replace tab, line feed, and carriage return characters with space character (Unicode character 32).

Sequence Model Group Child elements and model groups must be provided in the specified order in instances. See: http://www.w3.org/TR/xmlschema-1/#element-sequence.

Substitution Group Elements that are members of a substitution group can be used wherever the head element of the substitution group is referenced.

Substitution Group Exclusions (Applies to element declarations). Prohibits element declarations from nominating themselves as being able to substitute a given element declaration, if they have types that are derived from the original element's type using the specified derivation methods.

Target Namespace The target namespace identifies the namespace that components in this schema belongs to. If no target namespace is provided, then the schema components do not belong to any namespace.

Uniqueness Constraint Ensures uniqueness of an element/attribute value, or a combination of values, within a specified scope. See: http://www.w3.org/TR/xmlschema-1/#cIdentity-constraint_Definitions.

top