Access device end point used in the context of add that can have more than one contact defined.
Only Static Registration capabable devices may have more than one contact defined.
Port numbers are only used by devices with static line ordering.
Access device end point used in the context of modify that can have more than one contact defined.
Only Static Registration capabable devices may have more than one contact defined.
Port numbers are only used by devices with static line ordering.
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. -->
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. -->
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. -->
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. -->
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. -->
Request the user level data associated with Call Processing Policy.
The response is either a UserCallProcessingGetPolicyResponse18 or an
ErrorResponse.
XML Instance Representation
<...>
<!-- 'OCICommand' super type was not found in this schema. Some elements and attributes may be missing. -->
Response to UserCallProcessingGetPolicyRequest18.
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
Response to UserGetRequest19.
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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.
XML Instance Representation
<...>
<!-- 'OCICommand' super type was not found in this schema. Some elements and attributes may be missing. -->
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".
The response entries are sorted by "Last Name Unicode" first and
"First Name unicode" secondarily.
XML Instance Representation
<...>
<!-- 'OCIResponse' super type was not found in this schema. Some elements and attributes may be missing. -->
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. -->
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. -->
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. -->
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.
XML Instance Representation
<...>
<!-- 'OCICommand' super type was not found in this schema. Some elements and attributes may be missing. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
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. -->
The XML Instance Representation table above shows the schema component's content as an XML instance.
The minimum and maximum occurrence of elements and attributes are provided in square brackets, e.g. [0..1].
Model group information are shown in gray, e.g. Start Choice ... End Choice.
For type derivations, the elements and attributes that have been added to or changed from the base type's content are shown in bold.
If an element/attribute has a fixed value, the fixed value is shown in green, e.g. country="Australia".
Otherwise, the type of the element/attribute is displayed.
If the element/attribute's type is in the schema, a link is provided to it.
For local simple type definitions, the constraints are displayed in angle brackets, e.g. <<pattern = [1-9][0-9]{3}>>.
If a local element/attribute has documentation, it will be displayed in a window that pops up when the question mark inside the attribute or next to the element is clicked, e.g. <postcode>.
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.
Collapse Whitespace PolicyReplace 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.
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.
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 PolicyReplace tab, line feed, and carriage return characters with space character (Unicode character 32).
Substitution GroupElements 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 NamespaceThe 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.