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

Global Definitions

Complex Type: ReplacementOCICallControlApplicationIdList

Parent type: None
Sub-types: None
Name ReplacementOCICallControlApplicationIdList
Abstract no
Documentation A list of applicationIds that replaces a previously configured list. By convention, an element of this type may be set nill to clear the list.
XML Instance Representation
<...>
<applicationId> OCICallControlApplicationId </applicationId> [1..*]
</...>
Schema Component Representation
<xs:complexType name="ReplacementOCICallControlApplicationIdList">
<xs:sequence>
<xs:element name="applicationId" type=" OCICallControlApplicationId " minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: ShInterfaceUserIdDataEntry

Parent type: None
Sub-types: None
Name ShInterfaceUserIdDataEntry
Abstract no
Documentation ShInterface User Id Data Entry.
XML Instance Representation
<...>
<userType> UserType </userType> [1]
<publicUserIdentity> PublicUserIdentity </publicUserIdentity> [1]
<endpointType> EndpointType </endpointType> [1]
<SCSCFName> SIPURI </SCSCFName> [0..1]
<IMSUserState> IMSUserState </IMSUserState> [1]
</...>
Schema Component Representation
<xs:complexType name="ShInterfaceUserIdDataEntry">
<xs:sequence>
<xs:element name="userType" type=" UserType "/>
<xs:element name="publicUserIdentity" type=" PublicUserIdentity "/>
<xs:element name="endpointType" type=" EndpointType "/>
<xs:element name="SCSCFName" type=" SIPURI " minOccurs="0"/>
<xs:element name="IMSUserState" type=" IMSUserState "/>
</xs:sequence>
</xs:complexType>
top

Complex Type: TrunkAddressingMultipleContactAdd

Parent type: None
Sub-types: None
Name TrunkAddressingMultipleContactAdd
Abstract no
Documentation Trunk group endpoint that can have multiple contacts.
XML Instance Representation
<...>
<trunkGroupDeviceEndpoint> TrunkGroupDeviceMultipleContactEndpointAdd </trunkGroupDeviceEndpoint> [0..1]
<enterpriseTrunkName> EnterpriseTrunkName </enterpriseTrunkName> [0..1]
<alternateTrunkIdentity> AlternateTrunkIdentity </alternateTrunkIdentity> [0..1]
</...>
Schema Component Representation
<xs:complexType name="TrunkAddressingMultipleContactAdd">
<xs:sequence>
<xs:element name="trunkGroupDeviceEndpoint" type=" TrunkGroupDeviceMultipleContactEndpointAdd " minOccurs="0"/>
<xs:element name="enterpriseTrunkName" type=" EnterpriseTrunkName " minOccurs="0"/>
<xs:element name="alternateTrunkIdentity" type=" AlternateTrunkIdentity " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: TrunkAddressingMultipleContactModify

Parent type: None
Sub-types: None
Name TrunkAddressingMultipleContactModify
Abstract no
Documentation Trunk group endpoint that can have multiple contacts.
XML Instance Representation
<...>
<trunkGroupDeviceEndpoint> TrunkGroupDeviceMultipleContactEndpointModify </trunkGroupDeviceEndpoint> [0..1]
<enterpriseTrunkName> EnterpriseTrunkName </enterpriseTrunkName> [0..1]
<alternateTrunkIdentity> AlternateTrunkIdentity </alternateTrunkIdentity> [0..1]
</...>
Schema Component Representation
<xs:complexType name="TrunkAddressingMultipleContactModify">
<xs:sequence>
<xs:element name="trunkGroupDeviceEndpoint" type=" TrunkGroupDeviceMultipleContactEndpointModify " nillable="true" minOccurs="0"/>
<xs:element name="enterpriseTrunkName" type=" EnterpriseTrunkName " nillable="true" minOccurs="0"/>
<xs:element name="alternateTrunkIdentity" type=" AlternateTrunkIdentity " nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: TrunkAddressingMultipleContactRead

Parent type: None
Sub-types: None
Name TrunkAddressingMultipleContactRead
Abstract no
Documentation Trunk group endpoint that can have multiple contacts.
XML Instance Representation
<...>
<trunkGroupDeviceEndpoint> TrunkGroupDeviceMultipleContactEndpointRead </trunkGroupDeviceEndpoint> [0..1]
<enterpriseTrunkName> EnterpriseTrunkName </enterpriseTrunkName> [0..1]
<alternateTrunkIdentity> AlternateTrunkIdentity </alternateTrunkIdentity> [0..1]
</...>
Schema Component Representation
<xs:complexType name="TrunkAddressingMultipleContactRead">
<xs:sequence>
<xs:element name="trunkGroupDeviceEndpoint" type=" TrunkGroupDeviceMultipleContactEndpointRead " minOccurs="0"/>
<xs:element name="enterpriseTrunkName" type=" EnterpriseTrunkName " minOccurs="0"/>
<xs:element name="alternateTrunkIdentity" type=" AlternateTrunkIdentity " minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: TrunkGroupDeviceMultipleContactEndpointAdd

Parent type: None
Sub-types: None
Name TrunkGroupDeviceMultipleContactEndpointAdd
Abstract no
Documentation Trunk group device endpoint used in the context of modify that can have multiple contacts.
XML Instance Representation
<...>
<name> TrunkGroupName </name> [1]
<linePort> AccessDeviceEndpointLinePort </linePort> [1]
<contact> SIPContact </contact> [0..5]
</...>
Schema Component Representation
<xs:complexType name="TrunkGroupDeviceMultipleContactEndpointAdd">
<xs:sequence>
<xs:element name="name" type=" TrunkGroupName "/>
<xs:element name="linePort" type=" AccessDeviceEndpointLinePort "/>
<xs:element name="contact" type=" SIPContact " minOccurs="0" maxOccurs="5"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: TrunkGroupDeviceMultipleContactEndpointModify

Parent type: None
Sub-types: None
Name TrunkGroupDeviceMultipleContactEndpointModify
Abstract no
Documentation Trunk group device endpoint used in the context of modify that can have multiple contacts.
XML Instance Representation
<...>
<name> TrunkGroupName </name> [0..1]
<linePort> AccessDeviceEndpointLinePort </linePort> [0..1]
<contactList> ReplacementContactList </contactList> [0..1]
</...>
Schema Component Representation
<xs:complexType name="TrunkGroupDeviceMultipleContactEndpointModify">
<xs:sequence>
<xs:element name="name" type=" TrunkGroupName " minOccurs="0"/>
<xs:element name="linePort" type=" AccessDeviceEndpointLinePort " minOccurs="0"/>
<xs:element name="contactList" type=" ReplacementContactList " nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:complexType>
top

Complex Type: TrunkGroupDeviceMultipleContactEndpointRead

Parent type: None
Sub-types: None
Name TrunkGroupDeviceMultipleContactEndpointRead
Abstract no
Documentation Trunk group device endpoint that can have multiple contacts.
XML Instance Representation
<...>
<name> TrunkGroupName </name> [1]
<linePort> AccessDeviceEndpointLinePort </linePort> [1]
<contact> SIPContact </contact> [0..5]
<staticRegistrationCapable> xs:boolean </staticRegistrationCapable> [1]
<useDomain> xs:boolean </useDomain> [1]
<isPilotUser> xs:boolean </isPilotUser> [1]
</...>
Schema Component Representation
<xs:complexType name="TrunkGroupDeviceMultipleContactEndpointRead">
<xs:sequence>
<xs:element name="name" type=" TrunkGroupName "/>
<xs:element name="linePort" type=" AccessDeviceEndpointLinePort "/>
<xs:element name="contact" type=" SIPContact " minOccurs="0" maxOccurs="5"/>
<xs:element name="staticRegistrationCapable" type=" xs:boolean "/>
<xs:element name="useDomain" type=" xs:boolean "/>
<xs:element name="isPilotUser" type=" xs:boolean "/>
</xs:sequence>
</xs:complexType>
top

Complex Type: UserAccessDeviceFileGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAccessDeviceFileGetListRequest
Abstract no
Documentation Request to get the list of Device Management user modifiable files. The response is either UserAccessDeviceFileGetListResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<accessDevice> AccessDevice </accessDevice> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAccessDeviceFileGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="accessDevice" type=" AccessDevice "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAccessDeviceFileGetListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserAccessDeviceFileGetListResponse
Abstract no
Documentation Response to UserAccessDeviceFileGetListRequest. Contains a table of user modifiable Device Management files. The column headings are: "File Format", "Template URL".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<deviceFilesTable> core:OCITable </deviceFilesTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAccessDeviceFileGetListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="deviceFilesTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAccessDeviceFileGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAccessDeviceFileGetRequest
Abstract no
Documentation Request to get a user modifiable file. The response is either UserAccessDeviceFileGetResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<accessDevice> AccessDevice </accessDevice> [1]
<fileFormat> DeviceManagementFileFormat </fileFormat> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAccessDeviceFileGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="accessDevice" type=" AccessDevice "/>
<xs:element name="fileFormat" type=" DeviceManagementFileFormat "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAccessDeviceFileGetResponse

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

Complex Type: UserAccessDeviceFileModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAccessDeviceFileModifyRequest
Abstract no
Documentation Request to modify a user modifiable access device file. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<accessDevice> AccessDevice </accessDevice> [1]
<fileFormat> DeviceManagementFileFormat </fileFormat> [1]
<uploadFile> FileResource </uploadFile> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAccessDeviceFileModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="accessDevice" type=" AccessDevice "/>
<xs:element name="fileFormat" type=" DeviceManagementFileFormat "/>
<xs:element name="uploadFile" type=" FileResource "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAccessDeviceResetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAccessDeviceResetRequest
Abstract no
Documentation Reset a specific user 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. -->
<userId> UserId </userId> [1]
<accessDevice> AccessDevice </accessDevice> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAccessDeviceResetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="accessDevice" type=" AccessDevice "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAccessDeviceTagsGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAccessDeviceTagsGetRequest
Abstract no
Documentation Request to get all the device tag names and values for a specific device. The resolved tags are returned only if the device is the main device for this user. The response is either a UserAccessDeviceTagsGetResponse 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. -->
<userId> UserId </userId> [1]
<accessDevice> AccessDevice </accessDevice> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAccessDeviceTagsGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="accessDevice" type=" AccessDevice "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAccessDeviceTagsGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserAccessDeviceTagsGetResponse
Abstract no
Documentation Response to UserAccessDeviceTagsGetRequest. The response contains a table with columns: "Tag Name", and "Tag Value".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<deviceTagsTable> core:OCITable </deviceTagsTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAccessDeviceTagsGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="deviceTagsTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAddRequest17sp4

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAddRequest17sp4
Abstract no
Documentation Request to add a user. The domain is required in the userId. The password is not required if external authentication is enabled. The response is either SuccessResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<groupId> GroupId </groupId> [1]
<userId> UserId </userId> [1]
<lastName> LastName </lastName> [1]
<firstName> FirstName </firstName> [1]
<callingLineIdLastName> CallingLineIdLastName </callingLineIdLastName> [1]
<callingLineIdFirstName> CallingLineIdFirstName </callingLineIdFirstName> [1]
<nameDialingName> NameDialingName </nameDialingName> [0..1]
<hiraganaLastName> HiraganaLastName </hiraganaLastName> [0..1]
<hiraganaFirstName> HiraganaFirstName </hiraganaFirstName> [0..1]
<phoneNumber> DN </phoneNumber> [0..1]
<extension> Extension17 </extension> [0..1]
<callingLineIdPhoneNumber> DN </callingLineIdPhoneNumber> [0..1]
<password> Password </password> [0..1]
<department> DepartmentKey </department> [0..1]
<language> Language </language> [0..1]
<timeZone> TimeZone </timeZone> [0..1]
<alias> SIPURI </alias> [0..3]
Start Choice [1]
<accessDeviceEndpoint> AccessDeviceMultipleContactEndpointAdd </accessDeviceEndpoint> [0..1]
<trunkAddressing> TrunkAddressingMultipleContactAdd </trunkAddressing> [0..1]
End Choice
<title> Title </title> [0..1]
<pagerPhoneNumber> InformationalDN </pagerPhoneNumber> [0..1]
<mobilePhoneNumber> OutgoingDN </mobilePhoneNumber> [0..1]
<emailAddress> EmailAddress </emailAddress> [0..1]
<yahooId> YahooId </yahooId> [0..1]
<addressLocation> AddressLocation </addressLocation> [0..1]
<address> StreetAddress </address> [0..1]
<networkClassOfService> NetworkClassOfServiceName </networkClassOfService> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserAddRequest17sp4">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="groupId" type=" GroupId "/>
<xs:element name="userId" type=" UserId "/>
<xs:element name="lastName" type=" LastName "/>
<xs:element name="firstName" type=" FirstName "/>
<xs:element name="callingLineIdLastName" type=" CallingLineIdLastName "/>
<xs:element name="callingLineIdFirstName" type=" CallingLineIdFirstName "/>
<xs:element name="nameDialingName" type=" NameDialingName " minOccurs="0"/>
<xs:element name="hiraganaLastName" type=" HiraganaLastName " minOccurs="0"/>
<xs:element name="hiraganaFirstName" type=" HiraganaFirstName " minOccurs="0"/>
<xs:element name="phoneNumber" type=" DN " minOccurs="0"/>
<xs:element name="extension" type=" Extension17 " minOccurs="0"/>
<xs:element name="callingLineIdPhoneNumber" type=" DN " minOccurs="0"/>
<xs:element name="password" type=" Password " minOccurs="0"/>
<xs:element name="department" type=" DepartmentKey " minOccurs="0"/>
<xs:element name="language" type=" Language " minOccurs="0"/>
<xs:element name="timeZone" type=" TimeZone " minOccurs="0"/>
<xs:element name="alias" type=" SIPURI " minOccurs="0" maxOccurs="3"/>
<xs:choice>
<xs:element name="accessDeviceEndpoint" type=" AccessDeviceMultipleContactEndpointAdd " minOccurs="0"/>
<xs:element name="trunkAddressing" type=" TrunkAddressingMultipleContactAdd " minOccurs="0"/>
</xs:choice>
<xs:element name="title" type=" Title " minOccurs="0"/>
<xs:element name="pagerPhoneNumber" type=" InformationalDN " minOccurs="0"/>
<xs:element name="mobilePhoneNumber" type=" OutgoingDN " minOccurs="0"/>
<xs:element name="emailAddress" type=" EmailAddress " minOccurs="0"/>
<xs:element name="yahooId" type=" YahooId " minOccurs="0"/>
<xs:element name="addressLocation" type=" AddressLocation " minOccurs="0"/>
<xs:element name="address" type=" StreetAddress " minOccurs="0"/>
<xs:element name="networkClassOfService" type=" NetworkClassOfServiceName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAnnouncementFileAddRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAnnouncementFileAddRequest
Abstract no
Documentation Add an announcement to the user 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. -->
<userId> UserId </userId> [1]
<announcementFileName> AnnouncementFileName </announcementFileName> [1]
<announcementFile> LabeledMediaFileResource </announcementFile> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAnnouncementFileAddRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="announcementFileName" type=" AnnouncementFileName "/>
<xs:element name="announcementFile" type=" LabeledMediaFileResource "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAnnouncementFileDeleteListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAnnouncementFileDeleteListRequest
Abstract no
Documentation Delete one or more announcements from the user 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. -->
<userId> UserId </userId> [1]
<announcementFileKey> AnnouncementFileKey </announcementFileKey> [1..*]
</...>
Schema Component Representation
<xs:complexType name="UserAnnouncementFileDeleteListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="announcementFileKey" type=" AnnouncementFileKey " maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAnnouncementFileGetAvailableListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAnnouncementFileGetAvailableListRequest
Abstract no
Documentation Get the list of available announcement files for a User from the Announcement Repository, for Virtual subscribers the list will also include the announcements for it's group.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<announcementFileType> AnnouncementFileType </announcementFileType> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserAnnouncementFileGetAvailableListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="announcementFileType" type=" AnnouncementFileType " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAnnouncementFileGetAvailableListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserAnnouncementFileGetAvailableListResponse
Abstract no
Documentation Response to UserAnnouncementFileGetAvailableListRequest. The response contains a table with columns: "Name", "Media Type", "File Size" and "Repository Type". 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" is in Kilobytes. The "Repository Type" column contains the type of repository for the announcement file such as "User" or "Group" The "File Size" column contains the file size in kB of the announcement file.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<announcementTable> core:OCITable </announcementTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAnnouncementFileGetAvailableListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="announcementTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAnnouncementFileGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAnnouncementFileGetListRequest
Abstract no
Documentation Get the list of announcement names with associated media type and filesize for a User and given Announcement Repository Type The response is either a UserAnnouncementFileGetListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<announcementFileType> AnnouncementFileType </announcementFileType> [0..1]
<includeAnnouncementTable> xs:boolean </includeAnnouncementTable> [1]
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaAnnouncementFileName> SearchCriteriaAnnouncementFileName </searchCriteriaAnnouncementFileName> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserAnnouncementFileGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="announcementFileType" type=" AnnouncementFileType " minOccurs="0"/>
<xs:element name="includeAnnouncementTable" type=" xs:boolean "/>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaAnnouncementFileName" type=" SearchCriteriaAnnouncementFileName " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAnnouncementFileGetListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserAnnouncementFileGetListResponse
Abstract no
Documentation Response to UserAnnouncementFileGetListRequest. When requested, the response contains a table with columns: "Name", "Media Type", "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 in kB of the announcement file. The response also contains the current total file size (KB) for the user across all media types and the maximum total file size (MB) allowed for the user.
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]
<maxFileSize> RepositoryTotalFileSize </maxFileSize> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAnnouncementFileGetListResponse">
<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:element name="maxFileSize" type=" RepositoryTotalFileSize "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAnnouncementFileGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAnnouncementFileGetRequest
Abstract no
Documentation Request to get the announcement repository file information. The response is either UserAnnouncementFileGetResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<announcementFileKey> AnnouncementFileKey </announcementFileKey> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAnnouncementFileGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="announcementFileKey" type=" AnnouncementFileKey "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAnnouncementFileGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserAnnouncementFileGetResponse
Abstract no
Documentation Response to UserAnnouncementFileGetRequest. The response contains the file size (KB), uploaded timestamp, description and usage for an announcement file in the user announcement repository. The usage table has columns "Service Name", "Criteria Name" The "Service Name"" values correspond to string values of the 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. For Call Center and Route Point users the "Instance Name" column contains the instance id and when the announcement is being used by a DNIS, "Intance Name" column contans the instance id and the DNIS id. For Auto Attendants with submenus and the announcement is used by a submenu the "Instance Name" column will contain the submenu name
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<description> FileDescription </description> [1]
<filesize> xs:int </filesize> [1]
<lastUploaded> xs:dateTime </lastUploaded> [1]
<usageTable> core:OCITable </usageTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserAnnouncementFileGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="description" type=" FileDescription "/>
<xs:element name="filesize" type=" xs:int "/>
<xs:element name="lastUploaded" type=" xs:dateTime "/>
<xs:element name="usageTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAnnouncementFileModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAnnouncementFileModifyRequest
Abstract no
Documentation This command is used to change the name of the file or upload a new announcement file for an existing announcement in the user repository. When modifying the file type the command will fail if the media type of the new file changes the announcement from audio to video (or vice versa). The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<announcementFileKey> AnnouncementFileKey </announcementFileKey> [1]
<newAnnouncementFileName> AnnouncementFileName </newAnnouncementFileName> [0..1]
<announcementFile> LabeledMediaFileResource </announcementFile> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserAnnouncementFileModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="announcementFileKey" type=" AnnouncementFileKey "/>
<xs:element name="newAnnouncementFileName" type=" AnnouncementFileName " minOccurs="0"/>
<xs:element name="announcementFile" type=" LabeledMediaFileResource " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAssignedServicesGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserAssignedServicesGetListRequest
Abstract no
Documentation Get the list of assigned User and Group Services for the specified user. The response is either an UserAssignedServicesGetListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserAssignedServicesGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserAssignedServicesGetListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserAssignedServicesGetListResponse
Abstract no
Documentation Response to UserAssignedServicesGetListRequest. A user can have both user services and group services because of music on hold.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<groupServiceEntry> AssignedGroupServicesEntry </groupServiceEntry> [0..*]
<userServiceEntry> AssignedUserServicesEntry </userServiceEntry> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserAssignedServicesGetListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="groupServiceEntry" type=" AssignedGroupServicesEntry " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="userServiceEntry" type=" AssignedUserServicesEntry " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCallLogsClearRequest14sp4

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCallLogsClearRequest14sp4
Abstract no
Documentation Clear a user's call logs associated with Basic Call Logs and Enhanced Call Logs features. The calls logs are deleted from both Basic Call Logs and Enhanced Call Logs if both features are assigned. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
Start Choice [1]
<deleteAllCallLogs> true </deleteAllCallLogs> [0..1]
<deleteSpecifiedCallLogs> [1]
<placedCallLogId> CallLogId17sp4 </placedCallLogId> [0..*]
<receivedCallLogId> CallLogId17sp4 </receivedCallLogId> [0..*]
<missedCallLogId> CallLogId17sp4 </missedCallLogId> [0..*]
</deleteSpecifiedCallLogs>
End Choice
</...>
Schema Component Representation
<xs:complexType name="UserCallLogsClearRequest14sp4">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:choice>
<xs:element name="deleteAllCallLogs" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="deleteSpecifiedCallLogs">
<xs:complexType>
<xs:sequence>
<xs:element name="placedCallLogId" type=" CallLogId17sp4 " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="receivedCallLogId" type=" CallLogId17sp4 " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="missedCallLogId" type=" CallLogId17sp4 " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCallPoliciesGetRequest19sp1

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCallPoliciesGetRequest19sp1
Abstract no
Documentation Request the user level data associated with Call Policies. The response is either a UserCallPoliciesGetResponse19sp1 or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserCallPoliciesGetRequest19sp1">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCallPoliciesGetResponse19sp1

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

Complex Type: UserCallPoliciesModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCallPoliciesModifyRequest
Abstract no
Documentation Modify the user level data associated with Call Policies. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<redirectedCallsCOLPPrivacy> ConnectedLineIdentificationPrivacyOnRedirectedCalls </redirectedCallsCOLPPrivacy> [0..1]
<callBeingForwardedResponseCallType> CallBeingForwardedResponseCallType </callBeingForwardedResponseCallType> [0..1]
<callingLineIdentityForRedirectedCalls> CallingLineIdentityForRedirectedCalls </callingLineIdentityForRedirectedCalls> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserCallPoliciesModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="redirectedCallsCOLPPrivacy" type=" ConnectedLineIdentificationPrivacyOnRedirectedCalls " minOccurs="0"/>
<xs:element name="callBeingForwardedResponseCallType" type=" CallBeingForwardedResponseCallType " minOccurs="0"/>
<xs:element name="callingLineIdentityForRedirectedCalls" type=" CallingLineIdentityForRedirectedCalls " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCallProcessingGetPolicyRequest19sp1

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCallProcessingGetPolicyRequest19sp1
Abstract no
Documentation Request the user level data associated with Call Processing Policy. The response is either a UserCallProcessingGetPolicyResponse19sp1 or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserCallProcessingGetPolicyRequest19sp1">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCallProcessingGetPolicyResponse19sp1

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserCallProcessingGetPolicyResponse19sp1
Abstract no
Documentation Response to UserCallProcessingGetPolicyRequest19sp1. The useUserCLIDSetting attribute controls the CLID settings (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride) The useUserMediaSetting attribute controls the Media settings (medisPolicySelection, supportedMediaSetName) The useUserCallLimitsSetting attribute controls the Call Limits setting (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The following elements are only used in AS data mode: useUserDCLIDSetting enableDialableCallerID allowConfigurableCLIDForRedirectingIdentity allowDepartmentCLIDNameOverride
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<useUserCLIDSetting> xs:boolean </useUserCLIDSetting> [1]
<useUserMediaSetting> xs:boolean </useUserMediaSetting> [1]
<useUserCallLimitsSetting> xs:boolean </useUserCallLimitsSetting> [1]
<useUserDCLIDSetting> xs:boolean </useUserDCLIDSetting> [1]
<useMaxSimultaneousCalls> xs:boolean </useMaxSimultaneousCalls> [1]
<maxSimultaneousCalls> CallProcessingMaxSimultaneousCalls19sp1 </maxSimultaneousCalls> [1]
<useMaxSimultaneousVideoCalls> xs:boolean </useMaxSimultaneousVideoCalls> [1]
<maxSimultaneousVideoCalls> CallProcessingMaxSimultaneousCalls19sp1 </maxSimultaneousVideoCalls> [1]
<useMaxCallTimeForAnsweredCalls> xs:boolean </useMaxCallTimeForAnsweredCalls> [1]
<maxCallTimeForAnsweredCallsMinutes> CallProcessingMaxCallTimeForAnsweredCallsMinutes16 </maxCallTimeForAnsweredCallsMinutes> [1]
<useMaxCallTimeForUnansweredCalls> xs:boolean </useMaxCallTimeForUnansweredCalls> [1]
<maxCallTimeForUnansweredCallsMinutes> CallProcessingMaxCallTimeForUnansweredCallsMinutes19sp1 </maxCallTimeForUnansweredCallsMinutes> [1]
<mediaPolicySelection> MediaPolicySelection </mediaPolicySelection> [1]
<supportedMediaSetName> MediaSetName </supportedMediaSetName> [0..1]
<useMaxConcurrentRedirectedCalls> xs:boolean </useMaxConcurrentRedirectedCalls> [1]
<maxConcurrentRedirectedCalls> CallProcessingMaxConcurrentRedirectedCalls19sp1 </maxConcurrentRedirectedCalls> [1]
<useMaxFindMeFollowMeDepth> xs:boolean </useMaxFindMeFollowMeDepth> [1]
<maxFindMeFollowMeDepth> CallProcessingMaxFindMeFollowMeDepth19sp1 </maxFindMeFollowMeDepth> [1]
<maxRedirectionDepth> CallProcessingMaxRedirectionDepth19sp1 </maxRedirectionDepth> [1]
<useMaxConcurrentFindMeFollowMeInvocations> xs:boolean </useMaxConcurrentFindMeFollowMeInvocations> [1]
<maxConcurrentFindMeFollowMeInvocations> CallProcessingMaxConcurrentFindMeFollowMeInvocations19sp1 </maxConcurrentFindMeFollowMeInvocations> [1]
<clidPolicy> GroupCLIDPolicy </clidPolicy> [1]
<emergencyClidPolicy> GroupCLIDPolicy </emergencyClidPolicy> [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="UserCallProcessingGetPolicyResponse19sp1">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="useUserCLIDSetting" type=" xs:boolean "/>
<xs:element name="useUserMediaSetting" type=" xs:boolean "/>
<xs:element name="useUserCallLimitsSetting" type=" xs:boolean "/>
<xs:element name="useUserDCLIDSetting" type=" xs:boolean "/>
<xs:element name="useMaxSimultaneousCalls" type=" xs:boolean "/>
<xs:element name="maxSimultaneousCalls" type=" CallProcessingMaxSimultaneousCalls19sp1 "/>
<xs:element name="useMaxSimultaneousVideoCalls" type=" xs:boolean "/>
<xs:element name="maxSimultaneousVideoCalls" type=" CallProcessingMaxSimultaneousCalls19sp1 "/>
<xs:element name="useMaxCallTimeForAnsweredCalls" type=" xs:boolean "/>
<xs:element name="maxCallTimeForAnsweredCallsMinutes" type=" CallProcessingMaxCallTimeForAnsweredCallsMinutes16 "/>
<xs:element name="useMaxCallTimeForUnansweredCalls" type=" xs:boolean "/>
<xs:element name="maxCallTimeForUnansweredCallsMinutes" type=" CallProcessingMaxCallTimeForUnansweredCallsMinutes19sp1 "/>
<xs:element name="mediaPolicySelection" type=" MediaPolicySelection "/>
<xs:element name="supportedMediaSetName" type=" MediaSetName " minOccurs="0"/>
<xs:element name="useMaxConcurrentRedirectedCalls" type=" xs:boolean "/>
<xs:element name="maxConcurrentRedirectedCalls" type=" CallProcessingMaxConcurrentRedirectedCalls19sp1 "/>
<xs:element name="useMaxFindMeFollowMeDepth" type=" xs:boolean "/>
<xs:element name="maxFindMeFollowMeDepth" type=" CallProcessingMaxFindMeFollowMeDepth19sp1 "/>
<xs:element name="maxRedirectionDepth" type=" CallProcessingMaxRedirectionDepth19sp1 "/>
<xs:element name="useMaxConcurrentFindMeFollowMeInvocations" type=" xs:boolean "/>
<xs:element name="maxConcurrentFindMeFollowMeInvocations" type=" CallProcessingMaxConcurrentFindMeFollowMeInvocations19sp1 "/>
<xs:element name="clidPolicy" type=" GroupCLIDPolicy "/>
<xs:element name="emergencyClidPolicy" type=" GroupCLIDPolicy "/>
<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>
top

Complex Type: UserCallProcessingModifyPolicyRequest14sp7

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCallProcessingModifyPolicyRequest14sp7
Abstract no
Documentation Modify the user level data associated with Call Procesing Policy. The response is either a SuccessResponse or an ErrorResponse. The useUserCLIDSetting attribute controls the CLID settings (clidPolicy, emergencyClidPolicy, allowAlternateNumbersForRedirectingIdentity, useGroupName, allowConfigurableCLIDForRedirectingIdentity, allowDepartmentCLIDNameOverride) The useUserMediaSetting attribute controls the Media settings (medisPolicySelection, supportedMediaSetName) The useUserCallLimitsSetting attribute controls the Call Limits setting (useMaxSimultaneousCalls, maxSimultaneousCalls, useMaxSimultaneousVideoCalls, maxSimultaneousVideoCalls, useMaxCallTimeForAnsweredCalls, maxCallTimeForAnsweredCallsMinutes, useMaxCallTimeForUnansweredCalls, maxCallTimeForUnansweredCallsMinutes, useMaxConcurrentRedirectedCalls, useMaxFindMeFollowMeDepth, maxRedirectionDepth, useMaxConcurrentFindMeFollowMeInvocations, maxConcurrentFindMeFollowMeInvocations) The useUserDCLIDSetting controls the Dialable Caller ID settings (enableDialableCallerID) The following elements are only used in AS data mode: useUserDCLIDSetting enableDialableCallerID allowConfigurableCLIDForRedirectingIdentity allowDepartmentCLIDNameOverride
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<useUserCLIDSetting> xs:boolean </useUserCLIDSetting> [0..1]
<useUserMediaSetting> xs:boolean </useUserMediaSetting> [0..1]
<useUserCallLimitsSetting> xs:boolean </useUserCallLimitsSetting> [0..1]
<useUserDCLIDSetting> xs:boolean </useUserDCLIDSetting> [0..1]
<useMaxSimultaneousCalls> xs:boolean </useMaxSimultaneousCalls> [0..1]
<maxSimultaneousCalls> CallProcessingMaxSimultaneousCalls19sp1 </maxSimultaneousCalls> [0..1]
<useMaxSimultaneousVideoCalls> xs:boolean </useMaxSimultaneousVideoCalls> [0..1]
<maxSimultaneousVideoCalls> CallProcessingMaxSimultaneousCalls19sp1 </maxSimultaneousVideoCalls> [0..1]
<useMaxCallTimeForAnsweredCalls> xs:boolean </useMaxCallTimeForAnsweredCalls> [0..1]
<maxCallTimeForAnsweredCallsMinutes> CallProcessingMaxCallTimeForAnsweredCallsMinutes16 </maxCallTimeForAnsweredCallsMinutes> [0..1]
<useMaxCallTimeForUnansweredCalls> xs:boolean </useMaxCallTimeForUnansweredCalls> [0..1]
<maxCallTimeForUnansweredCallsMinutes> CallProcessingMaxCallTimeForUnansweredCallsMinutes19sp1 </maxCallTimeForUnansweredCallsMinutes> [0..1]
<mediaPolicySelection> MediaPolicySelection </mediaPolicySelection> [0..1]
<supportedMediaSetName> MediaSetName </supportedMediaSetName> [0..1]
<useMaxConcurrentRedirectedCalls> xs:boolean </useMaxConcurrentRedirectedCalls> [0..1]
<maxConcurrentRedirectedCalls> CallProcessingMaxConcurrentRedirectedCalls19sp1 </maxConcurrentRedirectedCalls> [0..1]
<useMaxFindMeFollowMeDepth> xs:boolean </useMaxFindMeFollowMeDepth> [0..1]
<maxFindMeFollowMeDepth> CallProcessingMaxFindMeFollowMeDepth19sp1 </maxFindMeFollowMeDepth> [0..1]
<maxRedirectionDepth> CallProcessingMaxRedirectionDepth19sp1 </maxRedirectionDepth> [0..1]
<useMaxConcurrentFindMeFollowMeInvocations> xs:boolean </useMaxConcurrentFindMeFollowMeInvocations> [0..1]
<maxConcurrentFindMeFollowMeInvocations> CallProcessingMaxConcurrentFindMeFollowMeInvocations19sp1 </maxConcurrentFindMeFollowMeInvocations> [0..1]
<clidPolicy> GroupCLIDPolicy </clidPolicy> [0..1]
<emergencyClidPolicy> GroupCLIDPolicy </emergencyClidPolicy> [0..1]
<allowAlternateNumbersForRedirectingIdentity> xs:boolean </allowAlternateNumbersForRedirectingIdentity> [0..1]
<useGroupName> xs:boolean </useGroupName> [0..1]
<enableDialableCallerID> xs:boolean </enableDialableCallerID> [0..1]
<blockCallingNameForExternalCalls> xs:boolean </blockCallingNameForExternalCalls> [0..1]
<allowConfigurableCLIDForRedirectingIdentity> xs:boolean </allowConfigurableCLIDForRedirectingIdentity> [0..1]
<allowDepartmentCLIDNameOverride> xs:boolean </allowDepartmentCLIDNameOverride> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserCallProcessingModifyPolicyRequest14sp7">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="useUserCLIDSetting" type=" xs:boolean " minOccurs="0"/>
<xs:element name="useUserMediaSetting" type=" xs:boolean " minOccurs="0"/>
<xs:element name="useUserCallLimitsSetting" type=" xs:boolean " minOccurs="0"/>
<xs:element name="useUserDCLIDSetting" type=" xs:boolean " minOccurs="0"/>
<xs:element name="useMaxSimultaneousCalls" type=" xs:boolean " minOccurs="0"/>
<xs:element name="maxSimultaneousCalls" type=" CallProcessingMaxSimultaneousCalls19sp1 " minOccurs="0"/>
<xs:element name="useMaxSimultaneousVideoCalls" type=" xs:boolean " minOccurs="0"/>
<xs:element name="maxSimultaneousVideoCalls" type=" CallProcessingMaxSimultaneousCalls19sp1 " minOccurs="0"/>
<xs:element name="useMaxCallTimeForAnsweredCalls" type=" xs:boolean " minOccurs="0"/>
<xs:element name="maxCallTimeForAnsweredCallsMinutes" type=" CallProcessingMaxCallTimeForAnsweredCallsMinutes16 " minOccurs="0"/>
<xs:element name="useMaxCallTimeForUnansweredCalls" type=" xs:boolean " minOccurs="0"/>
<xs:element name="maxCallTimeForUnansweredCallsMinutes" type=" CallProcessingMaxCallTimeForUnansweredCallsMinutes19sp1 " minOccurs="0"/>
<xs:element name="mediaPolicySelection" type=" MediaPolicySelection " minOccurs="0"/>
<xs:element name="supportedMediaSetName" type=" MediaSetName " nillable="true" minOccurs="0"/>
<xs:element name="useMaxConcurrentRedirectedCalls" type=" xs:boolean " minOccurs="0"/>
<xs:element name="maxConcurrentRedirectedCalls" type=" CallProcessingMaxConcurrentRedirectedCalls19sp1 " minOccurs="0"/>
<xs:element name="useMaxFindMeFollowMeDepth" type=" xs:boolean " minOccurs="0"/>
<xs:element name="maxFindMeFollowMeDepth" type=" CallProcessingMaxFindMeFollowMeDepth19sp1 " minOccurs="0"/>
<xs:element name="maxRedirectionDepth" type=" CallProcessingMaxRedirectionDepth19sp1 " minOccurs="0"/>
<xs:element name="useMaxConcurrentFindMeFollowMeInvocations" type=" xs:boolean " minOccurs="0"/>
<xs:element name="maxConcurrentFindMeFollowMeInvocations" type=" CallProcessingMaxConcurrentFindMeFollowMeInvocations19sp1 " minOccurs="0"/>
<xs:element name="clidPolicy" type=" GroupCLIDPolicy " 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="enableDialableCallerID" type=" xs:boolean " minOccurs="0"/>
<xs:element name="blockCallingNameForExternalCalls" 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>
top

Complex Type: UserCommunicationBarringAuthorizationCodeAddListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCommunicationBarringAuthorizationCodeAddListRequest
Abstract no
Documentation Add a list of Communication Barring Authorization codes to a user. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserCommunicationBarringAuthorizationCodeAddListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="code" type=" CommunicationBarringAuthorizationCodeEntry " minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCommunicationBarringAuthorizationCodeDeleteListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCommunicationBarringAuthorizationCodeDeleteListRequest
Abstract no
Documentation Delete a list of Communication Barring Authorization codes from a user. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserCommunicationBarringAuthorizationCodeDeleteListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="code" type=" CommunicationBarringAuthorizationCode " minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCommunicationBarringAuthorizationCodeGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCommunicationBarringAuthorizationCodeGetListRequest
Abstract no
Documentation Get a list of Communication Barring Authorization Code for a user. The response is either a UserCommunicationBarringAuthorizationCodeGetListResponse or an ErorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserCommunicationBarringAuthorizationCodeGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCommunicationBarringAuthorizationCodeGetListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserCommunicationBarringAuthorizationCodeGetListResponse
Abstract no
Documentation Response to UserCommunicationBarringAuthorizationCodeGetListRequest. Contains a list of Communication Barring Authorization Codes assigned to the user.
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="UserCommunicationBarringAuthorizationCodeGetListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="code" type=" CommunicationBarringAuthorizationCodeEntry " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCommunicationBarringGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCommunicationBarringGetRequest
Abstract no
Documentation Gets the Communication Barring settings for a user. The response is either a UserCommunicationBarringGetResponse 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. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserCommunicationBarringGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCommunicationBarringGetResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserCommunicationBarringGetResponse
Abstract no
Documentation Response to UserCommunicationBarringGetRequest. This command only applies to users in an Enterprise.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<useGroupSetting> xs:boolean </useGroupSetting> [1]
<profileName> CommunicationBarringProfileName </profileName> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserCommunicationBarringGetResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="useGroupSetting" type=" xs:boolean "/>
<xs:element name="profileName" type=" CommunicationBarringProfileName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserCommunicationBarringModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserCommunicationBarringModifyRequest
Abstract no
Documentation Modify the Communication Barring settings for a user. If useDefaultServiceProviderProfile is set to false, a profile name must be present. 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.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<useGroupSetting> xs:boolean </useGroupSetting> [0..1]
<profileName> CommunicationBarringProfileName </profileName> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserCommunicationBarringModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="useGroupSetting" type=" xs:boolean " minOccurs="0"/>
<xs:element name="profileName" type=" CommunicationBarringProfileName " minOccurs="0" nillable="true"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserDeleteRequest

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

Complex Type: UserDevicePoliciesGetRequest20

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserDevicePoliciesGetRequest20
Abstract no
Documentation Request the user level data associated with Device Policy. The response is either a UserDevicePoliciesGetResponse20 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. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserDevicePoliciesGetRequest20">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserDevicePoliciesGetResponse20

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserDevicePoliciesGetResponse20
Abstract no
Documentation Response to UserDevicePoliciesGetRequest201. enableDeviceFeatureSynchronization is ignored by the application server in Multiple User Shared mode.
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. -->
<lineMode> UserDevicePolicyLineMode </lineMode> [1]
<enableDeviceFeatureSynchronization> xs:boolean </enableDeviceFeatureSynchronization> [1]
<enableDnd> xs:boolean </enableDnd> [1]
<enableCallForwardingAlways> xs:boolean </enableCallForwardingAlways> [1]
<enableCallForwardingBusy> xs:boolean </enableCallForwardingBusy> [1]
<enableCallForwardingNoAnswer> xs:boolean </enableCallForwardingNoAnswer> [1]
<enableAcd> xs:boolean </enableAcd> [1]
<enableExecutive> xs:boolean </enableExecutive> [1]
<enableExecutiveAssistant> xs:boolean </enableExecutiveAssistant> [1]
<enableSecurityClassification> xs:boolean </enableSecurityClassification> [1]
<enableCallRecording> xs:boolean </enableCallRecording> [1]
</...>
Schema Component Representation
<xs:complexType name="UserDevicePoliciesGetResponse20">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="lineMode" type=" UserDevicePolicyLineMode "/>
<xs:element name="enableDeviceFeatureSynchronization" type=" xs:boolean "/>
<xs:element name="enableDnd" type=" xs:boolean "/>
<xs:element name="enableCallForwardingAlways" type=" xs:boolean "/>
<xs:element name="enableCallForwardingBusy" type=" xs:boolean "/>
<xs:element name="enableCallForwardingNoAnswer" type=" xs:boolean "/>
<xs:element name="enableAcd" type=" xs:boolean "/>
<xs:element name="enableExecutive" type=" xs:boolean "/>
<xs:element name="enableExecutiveAssistant" type=" xs:boolean "/>
<xs:element name="enableSecurityClassification" type=" xs:boolean "/>
<xs:element name="enableCallRecording" type=" xs:boolean "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserDevicePoliciesModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserDevicePoliciesModifyRequest
Abstract no
Documentation Modify the user level data associated with Device Policy. enableDeviceFeatureSynchronization can be configured regardless of lineMode, but is ignored by the application server in Multiple User Shared mode. 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. -->
<userId> UserId </userId> [1]
<lineMode> UserDevicePolicyLineMode </lineMode> [0..1]
<enableDeviceFeatureSynchronization> xs:boolean </enableDeviceFeatureSynchronization> [0..1]
<enableDnd> xs:boolean </enableDnd> [0..1]
<enableCallForwardingAlways> xs:boolean </enableCallForwardingAlways> [0..1]
<enableCallForwardingBusy> xs:boolean </enableCallForwardingBusy> [0..1]
<enableCallForwardingNoAnswer> xs:boolean </enableCallForwardingNoAnswer> [0..1]
<enableAcd> xs:boolean </enableAcd> [0..1]
<enableExecutive> xs:boolean </enableExecutive> [0..1]
<enableExecutiveAssistant> xs:boolean </enableExecutiveAssistant> [0..1]
<enableSecurityClassification> xs:boolean </enableSecurityClassification> [0..1]
<enableCallRecording> xs:boolean </enableCallRecording> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserDevicePoliciesModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="lineMode" type=" UserDevicePolicyLineMode " minOccurs="0"/>
<xs:element name="enableDeviceFeatureSynchronization" type=" xs:boolean " minOccurs="0"/>
<xs:element name="enableDnd" type=" xs:boolean " minOccurs="0"/>
<xs:element name="enableCallForwardingAlways" type=" xs:boolean " minOccurs="0"/>
<xs:element name="enableCallForwardingBusy" type=" xs:boolean " minOccurs="0"/>
<xs:element name="enableCallForwardingNoAnswer" type=" xs:boolean " minOccurs="0"/>
<xs:element name="enableAcd" type=" xs:boolean " minOccurs="0"/>
<xs:element name="enableExecutive" type=" xs:boolean " minOccurs="0"/>
<xs:element name="enableExecutiveAssistant" type=" xs:boolean " minOccurs="0"/>
<xs:element name="enableSecurityClassification" type=" xs:boolean " minOccurs="0"/>
<xs:element name="enableCallRecording" type=" xs:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserDnGetActivationListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserDnGetActivationListRequest
Abstract no
Documentation Request to get a list of DNs associated with a user and their activation state. The response is either UserDnGetActivationListResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserDnGetActivationListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserDnGetActivationListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserDnGetActivationListResponse
Abstract no
Documentation Response to UserDnGetActivationListRequest. The response contains a table with columns: "Phone Number", and "Activated". The "Phone Number" column contains a single DN. The "Activated" column indicates if the phone number is activated or not.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<dnTable> core:OCITable </dnTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserDnGetActivationListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="dnTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserEnterpriseCommonPhoneListGetPagedSortedListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserEnterpriseCommonPhoneListGetPagedSortedListRequest
Abstract no
Documentation Get an enterprise's common phone list for a user. The response is either a UserEnterpriseCommonPhoneListGetPagedSortedListResponse 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. The sort can be done on the name or the number in the common phone list.
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. -->
<userId> UserId </userId> [1]
<responsePagingControl> ResponsePagingControl </responsePagingControl> [1]
Start Choice [1]
<sortByEnterpriseCommonPhoneListNumber> SortByEnterpriseCommonPhoneListNumber </sortByEnterpriseCommonPhoneListNumber> [1]
<sortByEnterpriseCommonPhoneListName> SortByEnterpriseCommonPhoneListName </sortByEnterpriseCommonPhoneListName> [1]
End Choice
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
<searchCriteriaEnterpriseCommonPhoneListName> SearchCriteriaEnterpriseCommonPhoneListName </searchCriteriaEnterpriseCommonPhoneListName> [0..*]
<searchCriteriaEnterpriseCommonPhoneListNumber> SearchCriteriaEnterpriseCommonPhoneListNumber </searchCriteriaEnterpriseCommonPhoneListNumber> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserEnterpriseCommonPhoneListGetPagedSortedListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="responsePagingControl" type=" ResponsePagingControl "/>
<xs:choice>
<xs:element name="sortByEnterpriseCommonPhoneListNumber" type=" SortByEnterpriseCommonPhoneListNumber "/>
<xs:element name="sortByEnterpriseCommonPhoneListName" type=" SortByEnterpriseCommonPhoneListName "/>
</xs:choice>
<xs:element name="searchCriteriaModeOr" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="searchCriteriaEnterpriseCommonPhoneListName" type=" SearchCriteriaEnterpriseCommonPhoneListName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaEnterpriseCommonPhoneListNumber" type=" SearchCriteriaEnterpriseCommonPhoneListNumber " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserEnterpriseCommonPhoneListGetPagedSortedListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserEnterpriseCommonPhoneListGetPagedSortedListResponse
Abstract no
Documentation Response to the UserEnterpriseCommonPhoneListGetPagedSortedListRequest. The response contains the enterprise's common phone list. The response contains a table with column headings: "Name" and "Phone Number".
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. -->
<totalNumberOfRows> xs:int </totalNumberOfRows> [1]
<enterpriseCommonPhoneListTable> core:OCITable </enterpriseCommonPhoneListTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserEnterpriseCommonPhoneListGetPagedSortedListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="totalNumberOfRows" type=" xs:int "/>
<xs:element name="enterpriseCommonPhoneListTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserFeatureAccessCodeGetListRequest20

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserFeatureAccessCodeGetListRequest20
Abstract no
Documentation Get the list of feature access codes for a user. The response is either a UserFeatureAccessCodeGetListResponse20 or an ErrorResponse. In release 20 the "Call Recording" FAC name is changed to "Call Recording Start".
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserFeatureAccessCodeGetListRequest20">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserFeatureAccessCodeGetListResponse20

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserFeatureAccessCodeGetListResponse20
Abstract no
Documentation Response to the UserFeatureAccessCodeGetListRequest20. In release 20 the "Call Recording" FAC name is changed to "Call Recording Start".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<featureAccessCode> FeatureAccessCodeEntry </featureAccessCode> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserFeatureAccessCodeGetListResponse20">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="featureAccessCode" type=" FeatureAccessCodeEntry " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetListInGroupRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserGetListInGroupRequest
Abstract no
Documentation Request the list of users in a 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 a UserGetListInGroupResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<GroupId> GroupId </GroupId> [1]
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaUserFirstName> SearchCriteriaUserFirstName </searchCriteriaUserFirstName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaEmailAddress> SearchCriteriaEmailAddress </searchCriteriaEmailAddress> [0..*]
<searchCriteriaExactUserDepartment> SearchCriteriaExactUserDepartment </searchCriteriaExactUserDepartment> [0..1]
<searchCriteriaExactUserInTrunkGroup> SearchCriteriaExactUserInTrunkGroup </searchCriteriaExactUserInTrunkGroup> [0..1]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserGetListInGroupRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="GroupId" type=" GroupId "/>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserFirstName" type=" SearchCriteriaUserFirstName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaEmailAddress" type=" SearchCriteriaEmailAddress " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactUserDepartment" type=" SearchCriteriaExactUserDepartment " minOccurs="0" maxOccurs="1"/>
<xs:element name="searchCriteriaExactUserInTrunkGroup" type=" SearchCriteriaExactUserInTrunkGroup " minOccurs="0"/>
<xs:element name="searchCriteriaUserId" type=" SearchCriteriaUserId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetListInGroupResponse

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

Complex Type: UserGetListInServiceProviderRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserGetListInServiceProviderRequest
Abstract no
Documentation Request the list of users 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 UserGetListInServiceProviderResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaUserFirstName> SearchCriteriaUserFirstName </searchCriteriaUserFirstName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaEmailAddress> SearchCriteriaEmailAddress </searchCriteriaEmailAddress> [0..*]
<searchCriteriaExactUserInTrunkGroup> SearchCriteriaExactUserInTrunkGroup </searchCriteriaExactUserInTrunkGroup> [0..1]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
<searchCriteriaExactUserDepartment> SearchCriteriaExactUserDepartment </searchCriteriaExactUserDepartment> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserGetListInServiceProviderRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserFirstName" type=" SearchCriteriaUserFirstName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaEmailAddress" type=" SearchCriteriaEmailAddress " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactUserInTrunkGroup" type=" SearchCriteriaExactUserInTrunkGroup " minOccurs="0"/>
<xs:element name="searchCriteriaUserId" type=" SearchCriteriaUserId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactUserDepartment" type=" SearchCriteriaExactUserDepartment " minOccurs="0" maxOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetListInServiceProviderResponse

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

Complex Type: UserGetListInSystemRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserGetListInSystemRequest
Abstract no
Documentation Request the list of users 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 UserGetListInSystemResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaUserFirstName> SearchCriteriaUserFirstName </searchCriteriaUserFirstName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaEmailAddress> SearchCriteriaEmailAddress </searchCriteriaEmailAddress> [0..*]
<searchCriteriaGroupId> SearchCriteriaGroupId </searchCriteriaGroupId> [0..*]
<searchCriteriaExactServiceProvider> SearchCriteriaExactServiceProvider </searchCriteriaExactServiceProvider> [0..1]
<searchCriteriaExactUserInTrunkGroup> SearchCriteriaExactUserInTrunkGroup </searchCriteriaExactUserInTrunkGroup> [0..1]
<searchCriteriaExactUserNetworkClassOfService> SearchCriteriaExactUserNetworkClassOfService </searchCriteriaExactUserNetworkClassOfService> [0..1]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserGetListInSystemRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserFirstName" type=" SearchCriteriaUserFirstName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaEmailAddress" type=" SearchCriteriaEmailAddress " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaGroupId" type=" SearchCriteriaGroupId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactServiceProvider" type=" SearchCriteriaExactServiceProvider " minOccurs="0"/>
<xs:element name="searchCriteriaExactUserInTrunkGroup" type=" SearchCriteriaExactUserInTrunkGroup " minOccurs="0"/>
<xs:element name="searchCriteriaExactUserNetworkClassOfService" type=" SearchCriteriaExactUserNetworkClassOfService " minOccurs="0"/>
<xs:element name="searchCriteriaUserId" type=" SearchCriteriaUserId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetListInSystemResponse

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

Complex Type: UserGetRegistrationListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserGetRegistrationListRequest
Abstract no
Documentation Request to get a list of registrations for a user. The response is either a UserGetRegistrationListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserGetRegistrationListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetRegistrationListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserGetRegistrationListResponse
Abstract no
Documentation Response to UserGetRegistrationListRequest. The registrationTable table column headings are: "Device Level", "Device Name", "Order", "URI", "Expiration", "Line/Port", "Endpoint Type"", "Public Net Address", "Public Port", "Private Net Address", "Private Port", "User Agent", "Lockout Started", "Lockout Expires", "Lockout Count". The "Device Level" column contains one of the AccessDeviceLevel enumerated constants. The "Line/Port" column in IMS mode can be any Public User Identity which can be either a SIPURI or a TELURI. The expiration column will be empty when the registration is static. The Endpoint Type column contains one of the enumerated EndpointType values. The Endpoint Type is empty when the registration is against a TELURI. The table is sorted by: telURI (after SIPURI), Line/Port, static (after dynamic), order. Lockout times are shown in GMT offset. When a permanent lockout is shown, the "Lockout Expires" column is empty and the "Lockout Count" column contains the word Permanent.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<registrationTable> core:OCITable </registrationTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserGetRegistrationListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="registrationTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetRequest20

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserGetRequest20
Abstract no
Documentation Request to get the user information. The response is either UserGetResponse20 or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserGetRequest20">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetResponse20

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserGetResponse20
Abstract no
Documentation Response to UserGetRequest20. It is possible that the TrunkAddressingRead element is present with nothing populated in it which means the user is a trunk user. The following data elements are only used in AS data mode: contact[2]-contact[5] The country code (countryCode) included is the user's phone number country code when the user has a phone number assigned, or the user's Group associated country code when the user does not have a phone number assigned, or the system default country code when the user's Group does not have an associated country code. The nationalPrefix in this response is the one associated to the included countryCode.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<groupId> GroupId </groupId> [1]
<lastName> LastName </lastName> [1]
<firstName> FirstName </firstName> [1]
<callingLineIdLastName> CallingLineIdLastName </callingLineIdLastName> [1]
<callingLineIdFirstName> CallingLineIdFirstName </callingLineIdFirstName> [1]
<nameDialingName> NameDialingName </nameDialingName> [0..1]
<hiraganaLastName> HiraganaLastName </hiraganaLastName> [0..1]
<hiraganaFirstName> HiraganaFirstName </hiraganaFirstName> [0..1]
<phoneNumber> DN </phoneNumber> [0..1]
<extension> Extension17 </extension> [0..1]
<callingLineIdPhoneNumber> DN </callingLineIdPhoneNumber> [0..1]
<department> DepartmentKey </department> [0..1]
<departmentFullPath> DepartmentFullPathName </departmentFullPath> [0..1]
<language> Language </language> [1]
<timeZone> TimeZone </timeZone> [1]
<timeZoneDisplayName> TimeZoneDisplayName </timeZoneDisplayName> [1]
<defaultAlias> SIPURI </defaultAlias> [1]
<alias> SIPURI </alias> [0..3]
Start Choice [1]
<accessDeviceEndpoint> AccessDeviceMultipleContactEndpointRead20 </accessDeviceEndpoint> [0..1]
<trunkAddressing> TrunkAddressingMultipleContactRead </trunkAddressing> [0..1]
End Choice
<title> Title </title> [0..1]
<pagerPhoneNumber> InformationalDN </pagerPhoneNumber> [0..1]
<mobilePhoneNumber> OutgoingDN </mobilePhoneNumber> [0..1]
<emailAddress> EmailAddress </emailAddress> [0..1]
<yahooId> YahooId </yahooId> [0..1]
<addressLocation> AddressLocation </addressLocation> [0..1]
<address> StreetAddress </address> [0..1]
<countryCode> CountryCode </countryCode> [1]
<nationalPrefix> NationalPrefix </nationalPrefix> [0..1]
<networkClassOfService> NetworkClassOfServiceName </networkClassOfService> [0..1]
<officeZoneName> OfficeZoneName </officeZoneName> [0..1]
<primaryZoneName> ZoneName </primaryZoneName> [0..1]
<impId> IMPUserId </impId> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserGetResponse20">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="groupId" type=" GroupId "/>
<xs:element name="lastName" type=" LastName "/>
<xs:element name="firstName" type=" FirstName "/>
<xs:element name="callingLineIdLastName" type=" CallingLineIdLastName "/>
<xs:element name="callingLineIdFirstName" type=" CallingLineIdFirstName "/>
<xs:element name="nameDialingName" type=" NameDialingName " minOccurs="0"/>
<xs:element name="hiraganaLastName" type=" HiraganaLastName " minOccurs="0"/>
<xs:element name="hiraganaFirstName" type=" HiraganaFirstName " minOccurs="0"/>
<xs:element name="phoneNumber" type=" DN " minOccurs="0"/>
<xs:element name="extension" type=" Extension17 " minOccurs="0"/>
<xs:element name="callingLineIdPhoneNumber" type=" DN " minOccurs="0"/>
<xs:element name="department" type=" DepartmentKey " minOccurs="0"/>
<xs:element name="departmentFullPath" type=" DepartmentFullPathName " minOccurs="0"/>
<xs:element name="language" type=" Language "/>
<xs:element name="timeZone" type=" TimeZone "/>
<xs:element name="timeZoneDisplayName" type=" TimeZoneDisplayName "/>
<xs:element name="defaultAlias" type=" SIPURI "/>
<xs:element name="alias" type=" SIPURI " minOccurs="0" maxOccurs="3"/>
<xs:choice>
<xs:element name="accessDeviceEndpoint" type=" AccessDeviceMultipleContactEndpointRead20 " minOccurs="0"/>
<xs:element name="trunkAddressing" type=" TrunkAddressingMultipleContactRead " minOccurs="0"/>
</xs:choice>
<xs:element name="title" type=" Title " minOccurs="0"/>
<xs:element name="pagerPhoneNumber" type=" InformationalDN " minOccurs="0"/>
<xs:element name="mobilePhoneNumber" type=" OutgoingDN " minOccurs="0"/>
<xs:element name="emailAddress" type=" EmailAddress " minOccurs="0"/>
<xs:element name="yahooId" type=" YahooId " minOccurs="0"/>
<xs:element name="addressLocation" type=" AddressLocation " minOccurs="0"/>
<xs:element name="address" type=" StreetAddress " minOccurs="0"/>
<xs:element name="countryCode" type=" CountryCode "/>
<xs:element name="nationalPrefix" type=" NationalPrefix " minOccurs="0"/>
<xs:element name="networkClassOfService" type=" NetworkClassOfServiceName " minOccurs="0"/>
<xs:element name="officeZoneName" type=" OfficeZoneName " minOccurs="0"/>
<xs:element name="primaryZoneName" type=" ZoneName " minOccurs="0"/>
<xs:element name="impId" type=" IMPUserId " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetServiceInstanceListInServiceProviderRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserGetServiceInstanceListInServiceProviderRequest
Abstract no
Documentation Request the list of Service Instances in a service provider or an enterprise. It is possible to search by various criteria to restrict the number of rows returned. Multiple search criteria are logically ANDed together. searchCriteriaExactUserDepartment criteria is only applicable for an enterprise and is ignored if set for a service provider. The response is either a UserGetServiceInstanceListInServiceProviderResponse 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. -->
<serviceProviderId> ServiceProviderId </serviceProviderId> [1]
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<SearchCriteriaGroupId> SearchCriteriaGroupId </SearchCriteriaGroupId> [0..*]
<SearchCriteriaExactServiceType> SearchCriteriaExactServiceType </SearchCriteriaExactServiceType> [0..1]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
<searchCriteriaExactUserDepartment> SearchCriteriaExactUserDepartment </searchCriteriaExactUserDepartment> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserGetServiceInstanceListInServiceProviderRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="serviceProviderId" type=" ServiceProviderId "/>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="SearchCriteriaGroupId" type=" SearchCriteriaGroupId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="SearchCriteriaExactServiceType" type=" SearchCriteriaExactServiceType " minOccurs="0"/>
<xs:element name="searchCriteriaUserId" type=" SearchCriteriaUserId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactUserDepartment" type=" SearchCriteriaExactUserDepartment " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetServiceInstanceListInServiceProviderResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserGetServiceInstanceListInServiceProviderResponse
Abstract no
Documentation Response to UserGetServiceInstanceListInServiceProviderRequest. Contains a table with column headings : "User Id", "Group Id", "Service Type", "Name", "Phone Number", "Extension", "Department" in a row for each Service Instance. Possible values for Service Type column are ServiceType enums.
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. -->
<serviceInstanceTable> core:OCITable </serviceInstanceTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserGetServiceInstanceListInServiceProviderResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="serviceInstanceTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetServiceInstanceListInSystemRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserGetServiceInstanceListInSystemRequest
Abstract no
Documentation Request the list of Service Instances 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 UserGetServiceInstanceListInSystemResponse 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. -->
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaExactServiceType> SearchCriteriaExactServiceType </searchCriteriaExactServiceType> [0..1]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
<searchCriteriaGroupId> SearchCriteriaGroupId </searchCriteriaGroupId> [0..*]
<searchCriteriaExactServiceProvider> SearchCriteriaExactServiceProvider </searchCriteriaExactServiceProvider> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserGetServiceInstanceListInSystemRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaExactServiceType" type=" SearchCriteriaExactServiceType " minOccurs="0"/>
<xs:element name="searchCriteriaUserId" type=" SearchCriteriaUserId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaGroupId" type=" SearchCriteriaGroupId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactServiceProvider" type=" SearchCriteriaExactServiceProvider " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGetServiceInstanceListInSystemResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserGetServiceInstanceListInSystemResponse
Abstract no
Documentation Response to UserGetServiceInstanceListInSystemRequest. Contains a table with column headings : "User Id", "Group Id", "Serive Provider Id", "Service Type", "Name", "Phone Number", "Extension" in a row for each Service Instance. Possible values for Service Type column are ServiceType enums.
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. -->
<serviceInstanceTable> core:OCITable </serviceInstanceTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserGetServiceInstanceListInSystemResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="serviceInstanceTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGroupCommonPhoneListGetPagedSortedListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserGroupCommonPhoneListGetPagedSortedListRequest
Abstract no
Documentation Get a user's group's common phone list. The response is either a UserGroupCommonPhoneListGetPagedSortedListResponse 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. The sort can be done on the name or the number in the common phone list.
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. -->
<userId> UserId </userId> [1]
<responsePagingControl> ResponsePagingControl </responsePagingControl> [1]
Start Choice [1]
<sortByGroupCommonPhoneListNumber> SortByGroupCommonPhoneListNumber </sortByGroupCommonPhoneListNumber> [1]
<sortByGroupCommonPhoneListName> SortByGroupCommonPhoneListName </sortByGroupCommonPhoneListName> [1]
End Choice
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
<searchCriteriaGroupCommonPhoneListName> SearchCriteriaGroupCommonPhoneListName </searchCriteriaGroupCommonPhoneListName> [0..*]
<searchCriteriaGroupCommonPhoneListNumber> SearchCriteriaGroupCommonPhoneListNumber </searchCriteriaGroupCommonPhoneListNumber> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserGroupCommonPhoneListGetPagedSortedListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="responsePagingControl" type=" ResponsePagingControl "/>
<xs:choice>
<xs:element name="sortByGroupCommonPhoneListNumber" type=" SortByGroupCommonPhoneListNumber "/>
<xs:element name="sortByGroupCommonPhoneListName" type=" SortByGroupCommonPhoneListName "/>
</xs:choice>
<xs:element name="searchCriteriaModeOr" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="searchCriteriaGroupCommonPhoneListName" type=" SearchCriteriaGroupCommonPhoneListName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaGroupCommonPhoneListNumber" type=" SearchCriteriaGroupCommonPhoneListNumber " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGroupCommonPhoneListGetPagedSortedListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserGroupCommonPhoneListGetPagedSortedListResponse
Abstract no
Documentation Response to the UserGroupCommonPhoneListGetPagedSortedListRequest. The response contains the group's common phone list. The response contains a table with column headings: "Name" and "Phone Number".
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. -->
<totalNumberOfRows> xs:int </totalNumberOfRows> [1]
<groupCommonPhoneListTable> core:OCITable </groupCommonPhoneListTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserGroupCommonPhoneListGetPagedSortedListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="totalNumberOfRows" type=" xs:int "/>
<xs:element name="groupCommonPhoneListTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGroupCustomContactDirectoryGetPagedSortedListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserGroupCustomContactDirectoryGetPagedSortedListRequest
Abstract no
Documentation Gets a Custom Contact Directory in a group. The response is either UserGroupCustomContactDirectoryGetPagedSortedListResponse 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. The sort can be done on the user last name, first name, or department.
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. -->
<userId> UserId </userId> [1]
<name> CustomContactDirectoryName </name> [1]
<responsePagingControl> ResponsePagingControl </responsePagingControl> [1]
Start Choice [1]
<sortByUserLastName> SortByUserLastName </sortByUserLastName> [1]
<sortByUserFirstName> SortByUserFirstName </sortByUserFirstName> [1]
<sortByUserDepartment> SortByUserDepartment </sortByUserDepartment> [1]
End Choice
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaUserFirstName> SearchCriteriaUserFirstName </searchCriteriaUserFirstName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
<searchCriteriaMobilePhoneNumber> SearchCriteriaMobilePhoneNumber </searchCriteriaMobilePhoneNumber> [0..*]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaDepartmentName> SearchCriteriaDepartmentName </searchCriteriaDepartmentName> [0..*]
<searchCriteriaImpId> SearchCriteriaImpId </searchCriteriaImpId> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserGroupCustomContactDirectoryGetPagedSortedListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="name" type=" CustomContactDirectoryName "/>
<xs:element name="responsePagingControl" type=" ResponsePagingControl "/>
<xs:choice>
<xs:element name="sortByUserLastName" type=" SortByUserLastName "/>
<xs:element name="sortByUserFirstName" type=" SortByUserFirstName "/>
<xs:element name="sortByUserDepartment" type=" SortByUserDepartment "/>
</xs:choice>
<xs:element name="searchCriteriaModeOr" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserFirstName" type=" SearchCriteriaUserFirstName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaMobilePhoneNumber" type=" SearchCriteriaMobilePhoneNumber " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserId" type=" SearchCriteriaUserId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDepartmentName" type=" SearchCriteriaDepartmentName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaImpId" type=" SearchCriteriaImpId " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserGroupCustomContactDirectoryGetPagedSortedListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserGroupCustomContactDirectoryGetPagedSortedListResponse
Abstract no
Documentation Response to the UserGroupCustomContactDirectoryGetPagedSortedListRequest. Returns the number of entries that would be returned if the response Was not page size restricted. 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.
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. -->
<totalNumberOfRows> xs:int </totalNumberOfRows> [1]
<userTable> core:OCITable </userTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserGroupCustomContactDirectoryGetPagedSortedListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="totalNumberOfRows" type=" xs:int "/>
<xs:element name="userTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserLinePortGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserLinePortGetListRequest
Abstract no
Documentation Request to get all user's configured line ports.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserLinePortGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserLinePortGetListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserLinePortGetListResponse
Abstract no
Documentation Response to UserLinePortGetListRequest. Contains a table of line ports configured for a user The column headings are: "Line Port", "Line Port Type", "In Trunk Group", "Contact", "Contact2", "Contact3", "Contact4", "Contact5", " Authentication Mode ", and "Auto-Config Soft Client".
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<linePortTable> core:OCITable </linePortTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserLinePortGetListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="linePortTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserModifyRequest17sp4

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserModifyRequest17sp4
Abstract no
Documentation Request to modify a user. When oldPassword is specified, all password rule applies. If oldPassword in not specified, any password rule related to old password does not apply. The request will fail if officeZoneName or primaryZoneName is present but the Location-Based Calling Restrictions service is not assigned to the user. The response is either SuccessResponse or ErrorResponse. The following data elements are only used in AS data mode: contact[2]-contact[5] The impId and impPassword are accepted when the Third-Party IMP service is assigned to the user; when Integrated IMP service is assigned to the user and active, only the impPassword is accepted; all other cases, the request fails if either field is changed.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<lastName> LastName </lastName> [0..1]
<firstName> FirstName </firstName> [0..1]
<callingLineIdLastName> CallingLineIdLastName </callingLineIdLastName> [0..1]
<callingLineIdFirstName> CallingLineIdFirstName </callingLineIdFirstName> [0..1]
<nameDialingName> NameDialingName </nameDialingName> [0..1]
<hiraganaLastName> HiraganaLastName </hiraganaLastName> [0..1]
<hiraganaFirstName> HiraganaFirstName </hiraganaFirstName> [0..1]
<phoneNumber> DN </phoneNumber> [0..1]
<extension> Extension17 </extension> [0..1]
<callingLineIdPhoneNumber> DN </callingLineIdPhoneNumber> [0..1]
<oldPassword> Password </oldPassword> [0..1]
<newPassword> Password </newPassword> [0..1]
<department> DepartmentKey </department> [0..1]
<language> Language </language> [0..1]
<timeZone> TimeZone </timeZone> [0..1]
<sipAliasList> ReplacementSIPAliasList </sipAliasList> [0..1]
<endpoint> [0..1]
Start Choice [1]
<accessDeviceEndpoint> AccessDeviceMultipleContactEndpointModify </accessDeviceEndpoint> [1]
<trunkAddressing> TrunkAddressingMultipleContactModify </trunkAddressing> [1]
End Choice
</endpoint>
<title> Title </title> [0..1]
<pagerPhoneNumber> InformationalDN </pagerPhoneNumber> [0..1]
<mobilePhoneNumber> OutgoingDN </mobilePhoneNumber> [0..1]
<emailAddress> EmailAddress </emailAddress> [0..1]
<yahooId> YahooId </yahooId> [0..1]
<addressLocation> AddressLocation </addressLocation> [0..1]
<address> StreetAddress </address> [0..1]
<networkClassOfService> NetworkClassOfServiceName </networkClassOfService> [0..1]
<officeZoneName> OfficeZoneName </officeZoneName> [0..1]
<primaryZoneName> ZoneName </primaryZoneName> [0..1]
<impId> IMPUserId </impId> [0..1]
<impPassword> Password </impPassword> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserModifyRequest17sp4">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="lastName" type=" LastName " minOccurs="0"/>
<xs:element name="firstName" type=" FirstName " minOccurs="0"/>
<xs:element name="callingLineIdLastName" type=" CallingLineIdLastName " minOccurs="0"/>
<xs:element name="callingLineIdFirstName" type=" CallingLineIdFirstName " minOccurs="0"/>
<xs:element name="nameDialingName" type=" NameDialingName " nillable="true" minOccurs="0"/>
<xs:element name="hiraganaLastName" type=" HiraganaLastName " minOccurs="0"/>
<xs:element name="hiraganaFirstName" type=" HiraganaFirstName " minOccurs="0"/>
<xs:element name="phoneNumber" type=" DN " nillable="true" minOccurs="0"/>
<xs:element name="extension" type=" Extension17 " nillable="true" minOccurs="0"/>
<xs:element name="callingLineIdPhoneNumber" type=" DN " nillable="true" minOccurs="0"/>
<xs:element name="oldPassword" type=" Password " minOccurs="0"/>
<xs:element name="newPassword" type=" Password " nillable="true" minOccurs="0"/>
<xs:element name="department" type=" DepartmentKey " nillable="true" minOccurs="0"/>
<xs:element name="language" type=" Language " minOccurs="0"/>
<xs:element name="timeZone" type=" TimeZone " minOccurs="0"/>
<xs:element name="sipAliasList" type=" ReplacementSIPAliasList " nillable="true" minOccurs="0"/>
<xs:element name="endpoint" nillable="true" minOccurs="0">
<xs:complexType>
<xs:choice>
<xs:element name="accessDeviceEndpoint" type=" AccessDeviceMultipleContactEndpointModify "/>
<xs:element name="trunkAddressing" type=" TrunkAddressingMultipleContactModify "/>
</xs:choice>
</xs:complexType>
</xs:element>
<xs:element name="title" type=" Title " nillable="true" minOccurs="0"/>
<xs:element name="pagerPhoneNumber" type=" InformationalDN " nillable="true" minOccurs="0"/>
<xs:element name="mobilePhoneNumber" type=" OutgoingDN " nillable="true" minOccurs="0"/>
<xs:element name="emailAddress" type=" EmailAddress " nillable="true" minOccurs="0"/>
<xs:element name="yahooId" type=" YahooId " nillable="true" minOccurs="0"/>
<xs:element name="addressLocation" type=" AddressLocation " nillable="true" minOccurs="0"/>
<xs:element name="address" type=" StreetAddress " minOccurs="0"/>
<xs:element name="networkClassOfService" type=" NetworkClassOfServiceName " minOccurs="0"/>
<xs:element name="officeZoneName" type=" OfficeZoneName " minOccurs="0"/>
<xs:element name="primaryZoneName" type=" ZoneName " minOccurs="0"/>
<xs:element name="impId" type=" IMPUserId " nillable="true" minOccurs="0"/>
<xs:element name="impPassword" type=" Password " nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserModifyUserIdRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserModifyUserIdRequest
Abstract no
Documentation Modify the user id of a real or virtual user. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<newUserId> UserId </newUserId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserModifyUserIdRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="newUserId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserNetworkConferencingGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserNetworkConferencingGetRequest
Abstract no
Documentation Request the Network-Based Conferencing data for a specified user. The response is either a UserNetworkConferencingGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserNetworkConferencingGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserNetworkConferencingGetResponse

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

Complex Type: UserOCICallControlApplicationGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserOCICallControlApplicationGetListRequest
Abstract no
Documentation Get the OCI call control application list that can be used by the user. The response is either UserOCICallControlApplicationGetListResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserOCICallControlApplicationGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserOCICallControlApplicationGetListResponse

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

Complex Type: UserOCICallControlApplicationModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserOCICallControlApplicationModifyRequest
Abstract no
Documentation Modify which OCI Call Control Applications are enabled on a user The response is either SuccessResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<applicationIdList> ReplacementOCICallControlApplicationIdList </applicationIdList> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserOCICallControlApplicationModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="applicationIdList" type=" ReplacementOCICallControlApplicationIdList " nillable="true" minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPasswordInfoGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPasswordInfoGetRequest
Abstract no
Documentation Request the user's Web password information. The response is either a UserPasswordInfoGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPasswordInfoGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPasswordInfoGetResponse

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

Complex Type: UserPersonalPhoneListAddListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPersonalPhoneListAddListRequest
Abstract no
Documentation Add one or more entries to a user's personal 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. -->
<userId> UserId </userId> [1]
<entry> PhoneListEntry </entry> [1..*]
</...>
Schema Component Representation
<xs:complexType name="UserPersonalPhoneListAddListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="entry" type=" PhoneListEntry " maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPersonalPhoneListDeleteListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPersonalPhoneListDeleteListRequest
Abstract no
Documentation Delete one or more entries from a user's personal 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. -->
<userId> UserId </userId> [1]
<entryName> PhoneListEntryName </entryName> [1..*]
</...>
Schema Component Representation
<xs:complexType name="UserPersonalPhoneListDeleteListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="entryName" type=" PhoneListEntryName " maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPersonalPhoneListGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPersonalPhoneListGetListRequest
Abstract no
Documentation Get a user's personal phone list. The response is either a UserPersonalPhoneListGetListResponse 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. -->
<userId> UserId </userId> [1]
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
<searchCriteriaUserPersonalPhoneListName> SearchCriteriaUserPersonalPhoneListName </searchCriteriaUserPersonalPhoneListName> [0..*]
<searchCriteriaUserPersonalPhoneListNumber> SearchCriteriaUserPersonalPhoneListNumber </searchCriteriaUserPersonalPhoneListNumber> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserPersonalPhoneListGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaModeOr" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="searchCriteriaUserPersonalPhoneListName" type=" SearchCriteriaUserPersonalPhoneListName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserPersonalPhoneListNumber" type=" SearchCriteriaUserPersonalPhoneListNumber " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPersonalPhoneListGetListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserPersonalPhoneListGetListResponse
Abstract no
Documentation Response to the UserPersonalPhoneListGetListRequest. The response contains a user's personal phone list.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<entry> PhoneListEntry </entry> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserPersonalPhoneListGetListResponse">
<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>
top

Complex Type: UserPersonalPhoneListGetPagedSortedListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPersonalPhoneListGetPagedSortedListRequest
Abstract no
Documentation Get a user's personal phone list. The response is either a UserPersonalPhoneListGetPagedSortedListResponse 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. The sort can done by the personal phone list number or name.
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. -->
<userId> UserId </userId> [1]
<responsePagingControl> ResponsePagingControl </responsePagingControl> [1]
Start Choice [1]
<sortByUserPersonalPhoneListNumber> SortByUserPersonalPhoneListNumber </sortByUserPersonalPhoneListNumber> [1]
<sortByUserPersonalPhoneListName> SortByUserPersonalPhoneListName </sortByUserPersonalPhoneListName> [1]
End Choice
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
<searchCriteriaUserPersonalPhoneListName> SearchCriteriaUserPersonalPhoneListName </searchCriteriaUserPersonalPhoneListName> [0..*]
<searchCriteriaUserPersonalPhoneListNumber> SearchCriteriaUserPersonalPhoneListNumber </searchCriteriaUserPersonalPhoneListNumber> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserPersonalPhoneListGetPagedSortedListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="responsePagingControl" type=" ResponsePagingControl "/>
<xs:choice>
<xs:element name="sortByUserPersonalPhoneListNumber" type=" SortByUserPersonalPhoneListNumber "/>
<xs:element name="sortByUserPersonalPhoneListName" type=" SortByUserPersonalPhoneListName "/>
</xs:choice>
<xs:element name="searchCriteriaModeOr" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="searchCriteriaUserPersonalPhoneListName" type=" SearchCriteriaUserPersonalPhoneListName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserPersonalPhoneListNumber" type=" SearchCriteriaUserPersonalPhoneListNumber " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPersonalPhoneListGetPagedSortedListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserPersonalPhoneListGetPagedSortedListResponse
Abstract no
Documentation Response to the UserPersonalPhoneListGetPagedSortedListRequest. The response contains a user's personal phone list. The response contains a table with column headings: "Name" and "Phone Number".
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. -->
<totalNumberOfRows> xs:int </totalNumberOfRows> [1]
<personalPhoneListTable> core:OCITable </personalPhoneListTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPersonalPhoneListGetPagedSortedListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="totalNumberOfRows" type=" xs:int "/>
<xs:element name="personalPhoneListTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPersonalPhoneListModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPersonalPhoneListModifyRequest
Abstract no
Documentation Modify an entry in a user's personal 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. -->
<userId> UserId </userId> [1]
<entryName> PhoneListEntryName </entryName> [1]
<newEntryName> PhoneListEntryName </newEntryName> [0..1]
<phoneNumber> OutgoingDN </phoneNumber> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserPersonalPhoneListModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="entryName" type=" PhoneListEntryName "/>
<xs:element name="newEntryName" type=" PhoneListEntryName " minOccurs="0"/>
<xs:element name="phoneNumber" type=" OutgoingDN " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPhoneDirectoryGetListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPhoneDirectoryGetListRequest
Abstract no
Documentation Request a table containing the phone directory for a user's group. If the user's 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 includeCommonPhoneList is set to true). If the user's group is part of a service provider, the directory includes all users in the group and all entries in the common phone list (if includeCommonPhoneList is set to true) of the specified group. The response is either UserPhoneDirectoryGetListResponse or ErrorResponse. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criterias are included in the results. If no search criteria is specified, all results are returned. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned. Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<includeCommonPhoneList> xs:boolean </includeCommonPhoneList> [1]
<responseSizeLimit> ResponseSizeLimit </responseSizeLimit> [0..1]
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaUserFirstName> SearchCriteriaUserFirstName </searchCriteriaUserFirstName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
<searchCriteriaMobilePhoneNumber> SearchCriteriaMobilePhoneNumber </searchCriteriaMobilePhoneNumber> [0..*]
<searchCriteriaEmailAddress> SearchCriteriaEmailAddress </searchCriteriaEmailAddress> [0..*]
<searchCriteriaExactUserDepartment> SearchCriteriaExactUserDepartment </searchCriteriaExactUserDepartment> [0..1]
<searchCriteriaExactUserGroup> SearchCriteriaExactUserGroup </searchCriteriaExactUserGroup> [0..1]
<searchCriteriaExactCustomContactDirectory> SearchCriteriaExactCustomContactDirectory </searchCriteriaExactCustomContactDirectory> [0..1]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaImpId> SearchCriteriaImpId </searchCriteriaImpId> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserPhoneDirectoryGetListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="includeCommonPhoneList" type=" xs:boolean "/>
<xs:element name="responseSizeLimit" type=" ResponseSizeLimit " minOccurs="0"/>
<xs:element name="searchCriteriaModeOr" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserFirstName" type=" SearchCriteriaUserFirstName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaMobilePhoneNumber" type=" SearchCriteriaMobilePhoneNumber " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaEmailAddress" type=" SearchCriteriaEmailAddress " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactUserDepartment" type=" SearchCriteriaExactUserDepartment " minOccurs="0"/>
<xs:element name="searchCriteriaExactUserGroup" type=" SearchCriteriaExactUserGroup " minOccurs="0"/>
<xs:element name="searchCriteriaExactCustomContactDirectory" type=" SearchCriteriaExactCustomContactDirectory " minOccurs="0"/>
<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>
top

Complex Type: UserPhoneDirectoryGetListResponse

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

Complex Type: UserPhoneDirectoryGetPagedListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPhoneDirectoryGetPagedListRequest
Abstract no
Documentation Request a table containing the phone directory for a user. Setting isEnterpriseRequested to true will return enterprise directory members in the response if the user is in an enterprise. Otherwise, just the group directory members for a user are returned in the response. The response is either UserPhoneDirectoryGetPagedListResponse or ErrorResponse. The search can be done using multiple criterias. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criterias are included in the results. If no search criteria is specified, all results are returned. In all cases, if a responseSizeLimit is specified and the number of matching results is more than this limit, then an ErrorResponse is returned. Specifying searchCriteriaModeOr without any search criteria results in an ErrorResponse. The boolean sortByFirstName is optional. If it is not specified, the response is sorted by Last Name.
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. -->
<userId> UserId </userId> [1]
<isEnterpriseInfoRequested> xs:boolean </isEnterpriseInfoRequested> [1]
<responsePagingControl> ResponsePagingControl </responsePagingControl> [1]
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaUserFirstName> SearchCriteriaUserFirstName </searchCriteriaUserFirstName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaGroupLocationCode> SearchCriteriaGroupLocationCode </searchCriteriaGroupLocationCode> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
<searchCriteriaMobilePhoneNumber> SearchCriteriaMobilePhoneNumber </searchCriteriaMobilePhoneNumber> [0..*]
<searchCriteriaEmailAddress> SearchCriteriaEmailAddress </searchCriteriaEmailAddress> [0..*]
<searchCriteriaYahooId> SearchCriteriaYahooId </searchCriteriaYahooId> [0..*]
<searchCriteriaExactUserGroup> SearchCriteriaExactUserGroup </searchCriteriaExactUserGroup> [0..1]
<searchCriteriaExactUserDepartment> SearchCriteriaExactUserDepartment </searchCriteriaExactUserDepartment> [0..1]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaImpId> SearchCriteriaImpId </searchCriteriaImpId> [0..*]
<sortByFirstName> xs:boolean </sortByFirstName> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserPhoneDirectoryGetPagedListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="isEnterpriseInfoRequested" type=" xs:boolean "/>
<xs:element name="responsePagingControl" type=" ResponsePagingControl "/>
<xs:element name="searchCriteriaModeOr" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserFirstName" type=" SearchCriteriaUserFirstName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaGroupLocationCode" type=" SearchCriteriaGroupLocationCode " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaMobilePhoneNumber" type=" SearchCriteriaMobilePhoneNumber " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaEmailAddress" type=" SearchCriteriaEmailAddress " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaYahooId" type=" SearchCriteriaYahooId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactUserGroup" type=" SearchCriteriaExactUserGroup " minOccurs="0"/>
<xs:element name="searchCriteriaExactUserDepartment" type=" SearchCriteriaExactUserDepartment " minOccurs="0"/>
<xs:element name="searchCriteriaUserId" type=" SearchCriteriaUserId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaImpId" type=" SearchCriteriaImpId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="sortByFirstName" type=" xs:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPhoneDirectoryGetPagedListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserPhoneDirectoryGetPagedListResponse
Abstract no
Documentation Response to UserPhoneDirectoryGetPagedListRequest. Returns the number of entries that would be returned if the response Was not page size restricted. Contains a table with a row for each user and column headings: "User Id", "First Name", "Last Name", "First Name Unicode", "Last Name Unicode", "Hiragana First Name", "Hiragana Last Name", "Title", "Phone Number", "Extension", "Mobile", "Pager", "Email Address", "Yahoo Id", "Department", "Group Id", "Location", "Address Line 1", "Address Line 2", "City", "State", "Zip", "Country", "IMP Id", "Location Code". The response entries are sorted by "Last Name Unicode" first and "First Name unicode" secondarily.
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. -->
<totalNumberOfRows> xs:int </totalNumberOfRows> [1]
<directoryTable> core:OCITable </directoryTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPhoneDirectoryGetPagedListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="totalNumberOfRows" type=" xs:int "/>
<xs:element name="directoryTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPhoneDirectoryGetPagedSortedListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPhoneDirectoryGetPagedSortedListRequest
Abstract no
Documentation Request a table containing the phone directory for a user. Setting isEnterpriseRequested to true will return enterprise directory members in the response if the user is in an enterprise. Otherwise, just the group directory members for a user are returned in the response. The response is either UserPhoneDirectoryGetPagedSortedListResponse or ErrorResponse. The search can be done using multiple criterias. If the searchCriteriaModeOr is present, any result matching any one criteria is included in the results. Otherwise, only results matching all the search criterias 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. The sort can be performed on user last name, first name, or department.
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. -->
<userId> UserId </userId> [1]
<isEnterpriseInfoRequested> xs:boolean </isEnterpriseInfoRequested> [1]
<responsePagingControl> ResponsePagingControl </responsePagingControl> [1]
Start Choice [1]
<sortByUserLastName> SortByUserLastName </sortByUserLastName> [1]
<sortByUserFirstName> SortByUserFirstName </sortByUserFirstName> [1]
<sortByUserDepartment> SortByUserDepartment </sortByUserDepartment> [1]
End Choice
<searchCriteriaModeOr> true </searchCriteriaModeOr> [0..1]
<searchCriteriaUserLastName> SearchCriteriaUserLastName </searchCriteriaUserLastName> [0..*]
<searchCriteriaUserFirstName> SearchCriteriaUserFirstName </searchCriteriaUserFirstName> [0..*]
<searchCriteriaDn> SearchCriteriaDn </searchCriteriaDn> [0..*]
<searchCriteriaGroupLocationCode> SearchCriteriaGroupLocationCode </searchCriteriaGroupLocationCode> [0..*]
<searchCriteriaExtension> SearchCriteriaExtension </searchCriteriaExtension> [0..*]
<searchCriteriaMobilePhoneNumber> SearchCriteriaMobilePhoneNumber </searchCriteriaMobilePhoneNumber> [0..*]
<searchCriteriaEmailAddress> SearchCriteriaEmailAddress </searchCriteriaEmailAddress> [0..*]
<searchCriteriaYahooId> SearchCriteriaYahooId </searchCriteriaYahooId> [0..*]
<searchCriteriaExactUserGroup> SearchCriteriaExactUserGroup </searchCriteriaExactUserGroup> [0..1]
<searchCriteriaDepartmentName> SearchCriteriaDepartmentName </searchCriteriaDepartmentName> [0..*]
<searchCriteriaUserId> SearchCriteriaUserId </searchCriteriaUserId> [0..*]
<searchCriteriaImpId> SearchCriteriaImpId </searchCriteriaImpId> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserPhoneDirectoryGetPagedSortedListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="isEnterpriseInfoRequested" type=" xs:boolean "/>
<xs:element name="responsePagingControl" type=" ResponsePagingControl "/>
<xs:choice>
<xs:element name="sortByUserLastName" type=" SortByUserLastName "/>
<xs:element name="sortByUserFirstName" type=" SortByUserFirstName "/>
<xs:element name="sortByUserDepartment" type=" SortByUserDepartment "/>
</xs:choice>
<xs:element name="searchCriteriaModeOr" type=" xs:boolean " fixed="true" minOccurs="0"/>
<xs:element name="searchCriteriaUserLastName" type=" SearchCriteriaUserLastName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaUserFirstName" type=" SearchCriteriaUserFirstName " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaDn" type=" SearchCriteriaDn " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaGroupLocationCode" type=" SearchCriteriaGroupLocationCode " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExtension" type=" SearchCriteriaExtension " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaMobilePhoneNumber" type=" SearchCriteriaMobilePhoneNumber " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaEmailAddress" type=" SearchCriteriaEmailAddress " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaYahooId" type=" SearchCriteriaYahooId " minOccurs="0" maxOccurs="unbounded"/>
<xs:element name="searchCriteriaExactUserGroup" type=" SearchCriteriaExactUserGroup " minOccurs="0"/>
<xs:element name="searchCriteriaDepartmentName" type=" SearchCriteriaDepartmentName " 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>
top

Complex Type: UserPhoneDirectoryGetPagedSortedListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserPhoneDirectoryGetPagedSortedListResponse
Abstract no
Documentation Response to UserPhoneDirectoryGetPagedSortedListRequest. Returns the number of entries that would be returned if the response Was not page size restricted. Contains a table with a row for each user and column headings: "User Id", "CLID First Name", "CLID Last Name", "First Name", "Last Name", "Hiragana First Name", "Hiragana Last Name", "Title", "Phone Number", "Extension", "Mobile", "Pager", "Email Address", "Yahoo Id", "Department", "Group Id", "Location", "Address Line 1", "Address Line 2", "City", "State", "Zip", "Country", "IMP Id", "Location Code".
Application Data <asDataModeSupported>
true
</asDataModeSupported>
<hssDataModeSupported>
false
</hssDataModeSupported>
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<totalNumberOfRows> xs:int </totalNumberOfRows> [1]
<directoryTable> core:OCITable </directoryTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPhoneDirectoryGetPagedSortedListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="totalNumberOfRows" type=" xs:int "/>
<xs:element name="directoryTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPhoneDirectoryGetSearchedListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPhoneDirectoryGetSearchedListRequest
Abstract no
Documentation Request a table containing the phone directory for a user. If the specified user 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 user's group. If the specified user is part of a service provider, the directory includes all users in the user's group and all entries in the common phone list of the specified user's group. It is possible to search the directory for names containing a specified search string. The search includes matches on first name or last name or common phone list names. The response is either UserPhoneDirectoryGetSearchedListResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<nameSearchString> PhoneDirectoryNameSearchString </nameSearchString> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserPhoneDirectoryGetSearchedListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="nameSearchString" type=" PhoneDirectoryNameSearchString " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPhoneDirectoryGetSearchedListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserPhoneDirectoryGetSearchedListResponse
Abstract no
Documentation Response to UserPhoneDirectoryGetSearchedListRequest. 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", "First Name", "Last Name" .
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<directoryTable> core:OCITable </directoryTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPhoneDirectoryGetSearchedListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="directoryTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPortalPasscodeGetInfoRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPortalPasscodeGetInfoRequest
Abstract no
Documentation Request the user's portal passcode information. The response is either a UserPortalPasscodeGetInfoResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPortalPasscodeGetInfoRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPortalPasscodeGetInfoResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserPortalPasscodeGetInfoResponse
Abstract no
Documentation Response to UserPortalPasscodeGetInfoRequest.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<isLoginDisabled> xs:boolean </isLoginDisabled> [1]
Start Choice [1]
<expirationDays> xs:int </expirationDays> [1]
<doesNotExpire> true </doesNotExpire> [1]
End Choice
<passcode> Passcode </passcode> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPortalPasscodeGetInfoResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="isLoginDisabled" type=" xs:boolean "/>
<xs:choice>
<xs:element name="expirationDays" type=" xs:int "/>
<xs:element name="doesNotExpire" type=" xs:boolean " fixed="true"/>
</xs:choice>
<xs:element name="passcode" type=" Passcode "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPortalPasscodeModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPortalPasscodeModifyRequest
Abstract no
Documentation Modify the user's Portal passcode The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<oldPasscode> Passcode </oldPasscode> [0..1]
<newPasscode> Passcode </newPasscode> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPortalPasscodeModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="oldPasscode" type=" Passcode " minOccurs="0"/>
<xs:element name="newPasscode" type=" Passcode "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPrimaryEndpointAdvancedSettingGetRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPrimaryEndpointAdvancedSettingGetRequest
Abstract no
Documentation Get the Users Primary Endpoint setting. The response is either a UserPrimaryEndpointAdvancedSettingGetResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserPrimaryEndpointAdvancedSettingGetRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserPrimaryEndpointAdvancedSettingGetResponse

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

Complex Type: UserPrimaryEndpointAdvancedSettingModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserPrimaryEndpointAdvancedSettingModifyRequest
Abstract no
Documentation Modify the Users Primary Endpoint line control settings. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<allowOrigination> xs:boolean </allowOrigination> [0..1]
<allowTermination> xs:boolean </allowTermination> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserPrimaryEndpointAdvancedSettingModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="allowOrigination" type=" xs:boolean " minOccurs="0"/>
<xs:element name="allowTermination" type=" xs:boolean " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserScheduleAddEventRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleAddEventRequest
Abstract no
Documentation Add an event to user 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. -->
<userId> UserId </userId> [1]
<scheduleKey> ScheduleKey </scheduleKey> [1]
<eventName> EventName </eventName> [1]
<startDate> xs:date </startDate> [1]
Start Choice [1]
<allDayEvent> true </allDayEvent> [1]
<startTime> HourMinute </startTime> [1]
<endTime> HourMinute </endTime> [1]
End Choice
<endDate> xs:date </endDate> [1]
<recurrence> Recurrence </recurrence> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleAddEventRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleKey" type=" ScheduleKey "/>
<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:element name="endTime" 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>
top

Complex Type: UserScheduleAddRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleAddRequest
Abstract no
Documentation Add a user 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. -->
<userId> UserId </userId> [1]
<scheduleName> ScheduleName </scheduleName> [1]
<scheduleType> ScheduleType </scheduleType> [1]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleAddRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleName" type=" ScheduleName "/>
<xs:element name="scheduleType" type=" ScheduleType "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserScheduleDeleteEventListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleDeleteEventListRequest
Abstract no
Documentation Delete a list of events from a user 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. -->
<userId> UserId </userId> [1]
<scheduleKey> ScheduleKey </scheduleKey> [1]
<eventName> EventName </eventName> [1..*]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleDeleteEventListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleKey" type=" ScheduleKey "/>
<xs:element name="eventName" type=" EventName " maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserScheduleDeleteListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleDeleteListRequest
Abstract no
Documentation Delete a list of user 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. -->
<userId> UserId </userId> [1]
<scheduleKey> ScheduleKey </scheduleKey> [1..*]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleDeleteListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleKey" type=" ScheduleKey " maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserScheduleGetEventDetailListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleGetEventDetailListRequest
Abstract no
Documentation Request the list of schedules viewable by a User. The list can be filtered by schedule type. The response is either a UserScheduleGetEventListForGroupResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<scheduleGlobalKey> ScheduleGlobalKey </scheduleGlobalKey> [1]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleGetEventDetailListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleGlobalKey" type=" ScheduleGlobalKey " minOccurs="1"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserScheduleGetEventDetailListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserScheduleGetEventDetailListResponse
Abstract no
Documentation Response to UserScheduleGetEventRequest. The response contains collection of event details of a requested schedule.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<scheduleEvents> ScheduleEvents </scheduleEvents> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleGetEventDetailListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="scheduleEvents" type=" ScheduleEvents " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserScheduleGetEventListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleGetEventListRequest
Abstract no
Documentation Get the list of events of a user schedule. The response is either a UserScheduleGetEventListResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<scheduleKey> ScheduleKey </scheduleKey> [1]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleGetEventListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleKey" type=" ScheduleKey "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserScheduleGetEventListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserScheduleGetEventListResponse
Abstract no
Documentation Response to UserScheduleGetEventListRequest. 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. -->
<eventName> EventName </eventName> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleGetEventListResponse">
<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>
top

Complex Type: UserScheduleGetEventRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleGetEventRequest
Abstract no
Documentation Get an event from a user schedule. The response is either a UserScheduleGetEventResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<scheduleKey> ScheduleKey </scheduleKey> [1]
<eventName> EventName </eventName> [1]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleGetEventRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleKey" type=" ScheduleKey "/>
<xs:element name="eventName" type=" EventName "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserScheduleGetEventResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserScheduleGetEventResponse
Abstract no
Documentation Response to UserScheduleGetEventRequest. The response contains the event of the user 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]
<startTime> HourMinute </startTime> [1]
<endTime> HourMinute </endTime> [1]
End Choice
<endDate> xs:date </endDate> [1]
<recurrence> Recurrence </recurrence> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleGetEventResponse">
<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:element name="endTime" 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>
top

Complex Type: UserScheduleGetListRequest17sp1

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleGetListRequest17sp1
Abstract no
Documentation Get the list of schedules viewable by a User. The list can be filtered by schedule type. The response is either a UserScheduleGetListResponse17sp1 or an ErrorResponse. This command is authorized to user who is Executive-Assistant of the Executive.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<scheduleType> ScheduleType </scheduleType> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleGetListRequest17sp1">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleType" type=" ScheduleType " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserScheduleGetListResponse17sp1

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserScheduleGetListResponse17sp1
Abstract no
Documentation Response to UserScheduleGetListRequest17sp1. The response contains a list of schedules viewable by the user. It contains the schedules defined for the user and the group the user belongs to. If the user belongs to an enterprise, the list also contains the schedules defined for the enterprise.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<scheduleGlobalKey> ScheduleGlobalKey </scheduleGlobalKey> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleGetListResponse17sp1">
<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>
top

Complex Type: UserScheduleModifyEventRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleModifyEventRequest
Abstract no
Documentation Modify an event of a user 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. -->
<userId> UserId </userId> [1]
<scheduleKey> ScheduleKey </scheduleKey> [1]
<eventName> EventName </eventName> [1]
<newEventName> EventName </newEventName> [0..1]
<startDate> xs:date </startDate> [0..1]
Start Choice [0..1]
<allDayEvent> true </allDayEvent> [1]
<startTime> HourMinute </startTime> [1]
<endTime> HourMinute </endTime> [1]
End Choice
<endDate> xs:date </endDate> [0..1]
<recurrence> Recurrence </recurrence> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleModifyEventRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleKey" type=" ScheduleKey "/>
<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:element name="endTime" 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>
top

Complex Type: UserScheduleModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserScheduleModifyRequest
Abstract no
Documentation Modify a user 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. -->
<userId> UserId </userId> [1]
<scheduleKey> ScheduleKey </scheduleKey> [1]
<newScheduleName> ScheduleName </newScheduleName> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserScheduleModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="scheduleKey" type=" ScheduleKey "/>
<xs:element name="newScheduleName" type=" ScheduleName " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserServiceAssignListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserServiceAssignListRequest
Abstract no
Documentation Request to assign the user services and service packs for a user. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<serviceName> UserService </serviceName> [0..*]
<servicePackName> ServicePackName </servicePackName> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserServiceAssignListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<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>
top

Complex Type: UserServiceGetAssignmentListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserServiceGetAssignmentListRequest
Abstract no
Documentation Requests the user's service and service pack assignment list with status. The response is either UserServiceGetAssignmentListResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserServiceGetAssignmentListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserServiceGetAssignmentListResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserServiceGetAssignmentListResponse
Abstract no
Documentation Response to UserServiceGetAssignmentListRequest. Contains two tables, one for the service packs, and one for the user services. The user table has the column headings: "Service Name", "Assigned", The service pack table's column headings are: "Service Pack Name", "Assigned", "Description". The "Assigned" column has either a true or false value
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<servicePacksAssignmentTable> core:OCITable </servicePacksAssignmentTable> [1]
<userServicesAssignmentTable> core:OCITable </userServicesAssignmentTable> [1]
</...>
Schema Component Representation
<xs:complexType name="UserServiceGetAssignmentListResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="servicePacksAssignmentTable" type=" core:OCITable "/>
<xs:element name="userServicesAssignmentTable" type=" core:OCITable "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserServiceIsAssignedRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserServiceIsAssignedRequest
Abstract no
Documentation Request to determine if a UserService or service pack is assigned to the user.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
Start Choice [1]
<serviceName> UserService </serviceName> [1]
<servicePackName> ServicePackName </servicePackName> [1]
End Choice
</...>
Schema Component Representation
<xs:complexType name="UserServiceIsAssignedRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:choice>
<xs:element name="serviceName" type=" UserService "/>
<xs:element name="servicePackName" type=" ServicePackName "/>
</xs:choice>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserServiceIsAssignedResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserServiceIsAssignedResponse
Abstract no
Documentation Returns true if the UserService or service pack 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="UserServiceIsAssignedResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="isAssigned" type=" xs:boolean "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserServiceUnassignListRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserServiceUnassignListRequest
Abstract no
Documentation Requests to unassign the user services and service packs for a user. The response is either a SuccessResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<serviceName> UserService </serviceName> [0..*]
<servicePackName> ServicePackName </servicePackName> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserServiceUnassignListRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<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>
top

Complex Type: UserShInterfaceGetPublicIdDataRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserShInterfaceGetPublicIdDataRequest
Abstract no
Documentation Returns the Sh non-transparent data stored against a Public User Identity (a SIP URI or TEL URI). The response is either a UserShInterfaceGetPublicIdDataResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<publicUserIdentity> PublicUserIdentity </publicUserIdentity> [1]
</...>
Schema Component Representation
<xs:complexType name="UserShInterfaceGetPublicIdDataRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="publicUserIdentity" type=" PublicUserIdentity "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserShInterfaceGetPublicIdDataResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserShInterfaceGetPublicIdDataResponse
Abstract no
Documentation Response to the UserShInterfaceGetPublicIdDataRequest. The response contains the Sh non-transparent data for the specified Public User Identity. The data also includes a userId, userType, and endpointType.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
<userType> UserType </userType> [1]
<endpointType> EndpointType </endpointType> [1]
<SCSCFName> SIPURI </SCSCFName> [0..1]
<IMSUserState> IMSUserState </IMSUserState> [1]
</...>
Schema Component Representation
<xs:complexType name="UserShInterfaceGetPublicIdDataResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
<xs:element name="userType" type=" UserType "/>
<xs:element name="endpointType" type=" EndpointType "/>
<xs:element name="SCSCFName" type=" SIPURI " minOccurs="0"/>
<xs:element name="IMSUserState" type=" IMSUserState "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserShInterfaceGetUserIdDataRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserShInterfaceGetUserIdDataRequest
Abstract no
Documentation Returns the Sh non-transparent data stored against a userId. The response is either a UserShInterfaceGetUserIdDataResponse or an ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<userId> UserId </userId> [1]
</...>
Schema Component Representation
<xs:complexType name="UserShInterfaceGetUserIdDataRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="userId" type=" UserId "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserShInterfaceGetUserIdDataResponse

Parent type: core:OCIDataResponse (derivation method: extension)
Sub-types: None
Name UserShInterfaceGetUserIdDataResponse
Abstract no
Documentation Response to the UserShInterfaceGetUserIdDataRequest. The response contains the Sh non-transparent data for the specified userId. The data also includes a userType, publicUserIdentity and endpointType.
XML Instance Representation
<...>
<!-- ' OCIResponse ' super type was not found in this schema. Some elements and attributes may be missing. -->
<entry> ShInterfaceUserIdDataEntry </entry> [0..*]
</...>
Schema Component Representation
<xs:complexType name="UserShInterfaceGetUserIdDataResponse">
<xs:complexContent>
<xs:extension base=" core:OCIDataResponse ">
<xs:sequence>
<xs:element name="entry" type=" ShInterfaceUserIdDataEntry " minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserShInterfaceModifyRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserShInterfaceModifyRequest
Abstract no
Documentation Modifies the Sh Interface non-transparent data associated with a Public User Identity. The response is a SuccessResponse or ErrorResponse.
XML Instance Representation
<...>
<!-- ' OCICommand ' super type was not found in this schema. Some elements and attributes may be missing. -->
<publicUserIdentity> PublicUserIdentity </publicUserIdentity> [1]
<SCSCFName> SIPURI </SCSCFName> [0..1]
<IMSUserState> IMSUserState </IMSUserState> [0..1]
</...>
Schema Component Representation
<xs:complexType name="UserShInterfaceModifyRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="publicUserIdentity" type=" PublicUserIdentity "/>
<xs:element name="SCSCFName" type=" SIPURI " minOccurs="0" nillable="true"/>
<xs:element name="IMSUserState" type=" IMSUserState " minOccurs="0"/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Complex Type: UserShInterfacePublicIdentityRefreshTaskStartRequest

Parent type: core:OCIRequest (derivation method: extension)
Sub-types: None
Name UserShInterfacePublicIdentityRefreshTaskStartRequest
Abstract no
Documentation Dispatches a Public Identity refresh task on the local Application Server node for the specified public identity. 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. -->
<publicUserIdentity> PublicUserIdentity </publicUserIdentity> [1]
</...>
Schema Component Representation
<xs:complexType name="UserShInterfacePublicIdentityRefreshTaskStartRequest">
<xs:complexContent>
<xs:extension base=" core:OCIRequest ">
<xs:sequence>
<xs:element name="publicUserIdentity" type=" PublicUserIdentity "/>
</xs:sequence>
</xs:extension>
</xs:complexContent>
</xs:complexType>
top

Simple Type: CallBeingForwardedResponseCallType

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name CallBeingForwardedResponseCallType
Content
  • Base XSD Type: token
  • value comes from list: {'Never'|'Internal Calls'|'All Calls'}
Documentation Call type choices for sending call being forward response on Redirected Calls
Schema Component Representation
<xs:simpleType name="CallBeingForwardedResponseCallType">
<xs:restriction base=" xs:token ">
<xs:enumeration value="Never"/>
<xs:enumeration value="Internal Calls"/>
<xs:enumeration value="All Calls"/>
</xs:restriction>
</xs:simpleType>
top

Simple Type: PhoneDirectoryNameSearchString

Parent type: xs:token (derivation method: restriction)
Sub-types: None
Name PhoneDirectoryNameSearchString
Content
  • Base XSD Type: token
  • length >= 1
Documentation Phone Directory Name Search String.
Schema Component Representation
<xs:simpleType name="PhoneDirectoryNameSearchString">
<xs:restriction base=" xs:token ">
<xs:minLength value="1"/>
</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