link
Akixi Developer Portal

# Application Users

In this chapter, you will learn how to programmatically create, modify, delete and view Akixi Application Users.

An Application User is the Akixi Service concept for a User account, which may be utilised for the following purposes:

# Administering The Akixi Service

Users for administering the application either manually via the web user interface or programmatically via the Web Services API. Administrative Users can also be potentially configured to allow running of reports, although this is generally not the suggested approach under the recommended Separation-Of-Duties security control philosophy)

# Reporting Supervisor Access

The creation of Customer accounts used to manage & run real-time & historic Akixi reports. These types of Users always have scope permissions set to a specific Telephony Server component, and often also against a definitive Partition as well as required for limiting reporting access scope against a particular site/location.

# Wallboard Screen Access Via Smart Televisions

An account User usually no different to a normal reporting supervisor, but for the specific purpose of running Desktop Wallboard or other specially configured reports for use on a smart TV.

Note:

Akixi Service User accounts are totally distinct and do not necessarily align with other account concepts within the underlying telephony platform. This is particularly the case for BroadWorks platform environments which often have the definitive concept of call centre supervisors, which affect their handset capability to perform various call control actions such as silent agent monitoring.

Also:

Please also note that depending on your own (developer) Akixi Service Application User scope privileges, you may only have access to view and configure Users assigned within a particular Akixi Service Telephony Server and/or Partition component scope. Contact your designated Application Provider or Administrator to obtain and/or modify your administrative User credentials appropriately for your own Akixi Service access requirements.

Warning

Making User configuration changes within the application will often directly affect the monthly billing charge applied to the corresponding Customer. Therefore, Application Administrators should only configure User accounts that the Customer specifically wishes to pay for.

# Supported Operations

The list of currently supported Application User operations is provided below. Operations related to Akixi Application Users start with a User prefix. They will be referred to as “User Operations” interchangeably hereafter.

Operation Name Operation Description
UserAdd Add a new User.
UserChange Change an existing User.
UserDelete Delete a User.
UserInfo Get information about a specific User.
UserList List all Users.

# User Request Parameters

Parameters used within UserAdd, UserChange, UserDelete, UserInfo, and UserList operations are listed within the table below, which indicates whether the corresponding Property is supported for a specific telephony platform type. To learn more about UserXXX parameters, please refer to the “Application User Properties” sub- section of the “Configuration-Specific Properties” chapter.

# Read-Only Properties After Initial Creation

Parameter Name Cisco Broadworks Broadsoft M6 Siemens/Unify HiPath3000 Panasonic TDA/NCP Demo Simulator
Username ✅ ✅ ✅ ✅ ✅

# Fully Updatable Properties

Parameter Name Cisco Broadworks Broadsoft M6 Siemens/Unify HiPath3000 Panasonic TDA/NCP Demo Simulator
EmailAddr ✅ ✅ ✅ ✅ ✅
FullName ✅ ✅ ✅ ✅ ✅
LockOut ✅ ✅ ✅ ✅ ✅
Password ✅ ✅ ✅ ✅ ✅
PasswordChgRequired ✅ ✅ ✅ ✅ ✅
EnableMFA ✅ ✅ ✅ ✅ ✅
SynchroniseSupervisorPermissions ✅ ❌ ❌ ❌ ❌
SendWelcomeEmail ✅ ✅ ✅ ✅ ✅
DefaultLang ✅ ✅ ✅ ✅ ✅

# Permission Properties (Permissions Container)

Each property under the Permissions container accepts a comma-separated(,) list of the permissions. These user permissions are helpful to restrict a user's access to the Akixi platform at a granular level. The user permissions are divided into three groups Admin, NonAdmin, and Other permissions.

For a detailed list of all the possible user permissions please refer to the section Configuration Specific Properties > Application User Properties > Permissions Container Properties or click here.

Parameter Name Cisco Broadworks Broadsoft M6 Siemens/Unify HiPath3000 Panasonic TDA/NCP Demo Simulator
Admin ✅ ✅ ✅ ✅ ✅
NonAdmin ✅ ✅ ✅ ✅ ✅
Other ✅ ✅ ✅ ✅ ✅

# Scope Properties (Scope Container)

Parameter Name Cisco Broadworks Broadsoft M6 Siemens/Unify HiPath3000 Panasonic TDA/NCP Demo Simulator
CMEnvironmentID – Scope Container ✅ ✅ ✅ ✅ ✅
TelSysID – Scope Container ✅ ✅ ✅ ✅ ✅
PartIDInTelSys – Scope Container ✅ ✅ ✅ ✅ ✅
DeviceNumber – Scope Container ✅ ✅ ✅ ✅ ✅
AgentNumber – Scope Container ✅ ✅ ✅ ✅ ✅
ReportingAccess ✅ ✅ ✅ ✅ ✅
Admin ✅ ✅ ✅ ✅ ✅
CallRecIntID ✅ ✅ ✅ ✅ ✅
ReportReadOnly ✅ ✅ ✅ ✅ ✅

# Endpoint Properties (Endpoint Container)

Parameter Name Cisco Broadworks Broadsoft M6 Siemens/Unify HiPath3000 Panasonic TDA/NCP Demo Simulator
TelSysID – Endpoint Container ✅ ✅ ✅ ✅ ✅
PartIDInTelSys – Endpoint Container ✅ ✅ ✅ ✅ ✅
DeviceNumber – Endpoint Container ✅ ✅ ✅ ✅ ✅
AgentNumber – Endpoint Container ✅ ✅ ✅ ✅ ✅

# Advanced Properties (Advanced Container)

Parameter Name Cisco Broadworks Broadsoft M6 Siemens/Unify HiPath3000 Panasonic TDA/NCP Demo Simulator
PromptForTerms ✅ ✅ ✅ ✅ ✅
NotifyPasswordChgs ✅ ✅ ✅ ✅ ✅
ReportUpdInterval ✅ ✅ ✅ ✅ ✅
DisableMediaPlugIns ✅ ✅ ✅ ✅ ✅
DisableDragDropFeatures ✅ ✅ ✅ ✅ ✅
JavaScriptAuditOutput ✅ ✅ ✅ ✅ ✅

# UserAdd

Akixi Application User configuration entries can be added by calling UserAdd requests.

# UserAdd Request

Below shows an example of an Application User configuration entry creation operation. This request includes all parameters supported by UserAdd operation. Depending on your initial requirements, your actual request might be different from the sample request below. You must encrypt the User’s password value before sending this request. Please refer to the “Password Property Values” paragraph for further details on encryption/decryption steps.

<Request Operation="UserAdd">
    <InvokeID>00024</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <Property Name="Username">supervisor1@example.com</Property>
        <Property Name="EmailAddr">test@example.com</Property>
        <Property Name="FullName">Sample Supervisor Account</Property>
        <Property Name="LockOut">False</Property>
        <!--AES-128 encrypted and Base-64 encoded password value. -->
        <Property Name="Password">test</Property>
        <Property Name="PasswordChgRequired">False</Property>
		<Property Name="EnableMFA">True</Property>
        <Property Name="SynchroniseSupervisorPermissions">False</Property>
        <Property Name="SendWelcomeEmail">False</Property>
        <Property Name="DefaultLang">en_GB</Property>
        <!-- Scope-related Properties.-->
        <Container Name="Scope">
            <Property Name="CMEnvironmentID">d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613</Property>
            <Property Name="TelSysID">1</Property>
            <Property Name="PartIDInTelSys">1</Property>
            <Property Name="DeviceNumber">All</Property>
            <Property Name="AgentNumber">All</Property>
            <Property Name="ReportingAccess">Akixi 3000</Property>
        </Container>
        <!-- Permissions-related Properties.-->
        <Container Name="Permissions">
            <Property Name="Admin">Device|Create,ACDAgent|Create,Code|Create,DirectoryEntry|Create,Partition|Create,TelSys|Create,Omnichannel|Create,User|Create,Recording|Create,CME|Create,Device|Read,ACDAgent|Read,Code|Read,DirectoryEntry|Read,Partition|Read,TelSys|Read,Omnichannel|Read,User|Read,Recording|Read,CME|Read,Message|Read,Database|Read,LogMngmt|Read,CallControl|Read,License|Read,Logging|Read,Device|Update,ACDAgent|Update,Code|Update,DirectoryEntry|Update,Partition|Update,TelSys|Update,Omnichannel|Update,User|Update,Recording|Update,CME|Update,Message|Update,Database|Update,LogMngmt|Update,License|Update,Device|Delete,ACDAgent|Delete,Code|Delete,DirectoryEntry|Delete,Partition|Delete,TelSys|Delete,Omnichannel|Delete,User|Delete,Recording|Delete,CME|Delete,Message|Delete,SignInAs,ReportCopy,ChangeTelSysPartitionLicenseLevel,BillingSummary,BillingCDRs,SyncPartition,AuditTrail|Read,TelSysStatus|Read,OmnichannelStatus|Read,ServerStatus|Read</Property>
            <Property Name="NonAdmin">Report|Create,Report|Read,Report|Update,Report|Delete,ReportDataAPI,AdvancedMobileAppFeatures</Property>
            <Property Name="Other">ConcurrentSignIn,ServiceNotifications</Property>
        </Container>
        <!-- Endpoint-related Properties.-->
        <Container Name="Endpoint">
            <Property Name="TelSysID">1</Property>
            <Property Name="PartIDInTelSys">1</Property>
            <Property Name="DeviceNumber">01234567890</Property>
            <Property Name="AgentNumber">None</Property>
        </Container>
        <!-- Advanced Properties.-->
        <Container Name="Advanced">
            <Property Name="PromptForTerms">False</Property>
            <Property Name="NotifyPasswordChgs">False</Property>
            <Property Name="ReportUpdInterval">Auto</Property>
            <Property Name="DisableMediaPlugIns">False</Property>
            <Property Name="DisableDragDropFeatures">False</Property>
            <Property Name="JavaScriptAuditOutput">False</Property>
        </Container>
    </OperationPayload>
</Request>

# UserAdd Response

If your operation was successful, you will receive a response similar to the following:

<Response Result="Success">
    <InvokeID>00024</InvokeID>
</Response>

You will now be able to access the newly created Akixi Application User by invoking other User- related requests. The User can also be viewed & modified in the “Administration->Application Users” tab of the Akixi Web Application. If the request was unsuccessful (i.e. the response’s Result attribute depicts the Fail value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103, 10105, 10106, 10150, 10210*
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10513, 10514, 10515, 10516, 10517, 10518, 10519, 10700, 10701, 10702
Central Management Environment Component Related Error Codes 12100,12101,12102,12103,12104,12105,12106,12107,12108,12109,12110,12111,12112,12113,12114
Telephony Server Component Related Error Codes 11013
Partition Related Error Codes 11113, 11113, 11131
Device Related Error Codes 11161
ACD Agent Related Error Codes 11181
User Related Error Codes 11200, 11202, 11210, 11211, 11212, 11215, 11216, 11217, 11220, 11221, 11222, 11223, 11230*, 11231*, 11233*, 11234*, 11235*, 11236, 11237, 11238, 11239, 11258, 11259, 10703, 10704, 11280, 11286, 11287, 11288, 11289

Errors marked with (*) are returned when the response’s Result attribute depicts the PartialFail value.

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

# UserChange

Akixi Application User configuration entries can be modified by calling UserChange requests.

# UserChange Request

Below shows an example of a platform-specific Akixi Application User modification operation. This request includes all parameters supported by UserChange operation invoked in order to modify an existing Akixi Application User entry. Depending on your initial requirements, your actual request might be shorter than the sample request below. Please refer to the “Password Property Values” paragraph for further details on encryption/decryption steps.

<Request Operation="UserChange">
    <InvokeID>00025</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <!-- You can modify all Properties (the only exception is Username).-->
        <Property Name="Username">supervisor1@example.com</Property>
        <Property Name="EmailAddr">reporting2@acme-commsnet.com</Property>
        <Property Name="FullName">Sample Supervisor Account 2</Property>
        <Property Name="LockOut">False</Property>
        <Property Name="Password">C4gRIuo7ZTdpW/2LejGDLV2oSxAyJDU26a/iLRb4OeY=</Property>
        <Property Name="PasswordChgRequired">True</Property>
		<Property Name="EnableMFA">False</Property>
        <Property Name="SynchroniseSupervisorPermissions">False</Property>
        <Property Name="SendWelcomeEmail">True</Property>
        <Property Name="Defaultlang">en_GB</Property>
        <!-- Scope-related Properties.-->
        <Container Name="Scope">
            <Property Name="CMEnvironmentID">d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613</Property>
            <Property Name="TelSysID">100100</Property>
            <Property Name="PartIDInTelSys">2</Property>
            <Property Name="DeviceNumber">All</Property>
            <Property Name="AgentNumber">All</Property>
            <Property Name="ReportingAccess">Akixi 1000</Property>
        </Container>
        <!-- Permissions-related properties. -->
        <Container Name="Permissions">
            <Property Name="Admin">Device|Create,ACDAgent|Create,Code|Create,DirectoryEntry|Create,Partition|Create,TelSys|Create,Omnichannel|Create,User|Create,Recording|Create,CME|Create,Device|Read,ACDAgent|Read,Code|Read,DirectoryEntry|Read,Partition|Read,TelSys|Read,Omnichannel|Read,User|Read,Recording|Read,CME|Read,Message|Read,Database|Read,LogMngmt|Read,CallControl|Read,License|Read,Logging|Read,Device|Update,ACDAgent|Update,Code|Update,DirectoryEntry|Update,Partition|Update,TelSys|Update,Omnichannel|Update,User|Update,Recording|Update,CME|Update,Message|Update,Database|Update,LogMngmt|Update,License|Update,Device|Delete,ACDAgent|Delete,Code|Delete,DirectoryEntry|Delete,Partition|Delete,TelSys|Delete,Omnichannel|Delete,User|Delete,Recording|Delete,CME|Delete,Message|Delete,SignInAs,ReportCopy,ChangeTelSysPartitionLicenseLevel,BillingSummary,BillingCDRs,SyncPartition,AuditTrail|Read,TelSysStatus|Read,OmnichannelStatus|Read,ServerStatus|Read</Property>
            <Property Name="NonAdmin">Report|Create,Report|Read,Report|Update,Report|Delete,ReportDataAPI,AdvancedMobileAppFeatures</Property>
            <Property Name="Other">ConcurrentSignIn,ServiceNotifications</Property>
        </Container>
        <!-- Endpoint-related Properties.-->
        <Container Name="Endpoint">
            <Property Name="TelSysID">100100</Property>
            <Property Name="PartIDInTelSys">2</Property>
            <Property Name="DeviceNumber">01234567890</Property>
            <Property Name="AgentNumber">None</Property>
        </Container>
        <!-- Advanced Properties.-->
        <Container Name="Advanced">
            <Property Name="PromptForTerms">False</Property>
            <Property Name="NotifyPasswordChgs">False</Property>
            <Property Name="ReportUpdInterval">Auto</Property>
            <Property Name="DisableMediaPlugIns">False</Property>
            <Property Name="DisableDragDropFeatures">False</Property>
            <Property Name="JavaScriptAuditOutput">False</Property>
        </Container>
    </OperationPayload>
</Request>

# UserChange Response

If your operation was successful, you will receive a response similar to the following:

<Response Result="Success">
    <InvokeID>00025</InvokeID>
</Response>

If the request was unsuccessful (i.e. the response’s Result attribute depicts the Fail value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103, 10105, 10106, 10150, 10210*
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10513, 10514, 10515, 10516, 10517, 10518, 10519, 10700, 10701, 10702
Central Management Environment Component Related Error Codes 12100,12101,12102,12103,12104,12105,12106,12107,12108,12109,12110,12111,12112,12113,12114
Telephony Server Component Related Error Codes 11013
Partition Related Error Codes 11113, 11113, 11131
Device Related Error Codes 11161
ACD Agent Related Error Codes 11181
User Related Error Codes 11200, 11201, 11202, 11210, 11211, 11212, 11213, 11215, 11216, 11217, 11220, 11221, 11222, 11223, 11230*, 11233*, 11234*, 11235*, 11236, 11237 ,11238, 11239, 11258, 11259, 10703, 10704, 11280, 11286, 11287, 11288, 11289

Errors marked with (*) are returned when the response’s Result attribute depicts the PartialFail value.

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

# UserDelete

Akixi Application User configuration entries can be removed via UserDelete requests.

# UserDelete Request

The UserDelete request is quite minimalistic. In order to delete an Application User configuration entry, you must simply specify a correct username value:

<Request Operation="UserDelete">
    <InvokeID>00026</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <Property Name="Username">WebServicesAdmin@akixiprovider.com</Property>
    </OperationPayload>
</Request>

# UserDelete Response

If your operation was successful, you will receive a response similar to the following:

<Response Result="Success">
    <InvokeID>00026</InvokeID>
</Response>

If the request was unsuccessful (i.e. the response’s Result attribute depicts the Fail value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103, 10105, 10106, 10170
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10513, 10514, 10515, 10700, 10701, 10702
User Related Error Codes 11200, 11201

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

# UserList

The UserList operation can be used to list all Akixi Application Users that are configured against a certain CM Environment/Telephony Server/Partition component within the Akixi Service.

# UserList Request

By default, the body of UserList requests is quite minimalistic: you can simply specify the CM Environment ID, Telephony Server Identifier and the Partition Identifier within a Telephony Server in order to obtain the list of all underlying Akixi Application Users. If you want to list parameters that are not returned when you invoke a default “minimalistic” request, you can request additional values via UserFields Property. If you want to only list Application Users containing a specific Username or FullName, you can request for it via SearchQuery Payload Property. The Offset and Limit parameters can also be specified to request a specific subsection of the listed entries (if not specified these values are assumed to be 0 and 1000 respectively). Offset defines how many entries to skip over (i.e. which entry to start on if the first entry is entry 0) and Limit defines how many entries to retrieve:

<Request Operation="UserList">
    <InvokeID>00027</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <!-- Specify the number of entries to skip. -->
    <Offset>100</Offset>
    <!-- Specify how many entries to retrieve after the offset. -->
    <Limit>20</Limit>
    <OperationPayload>
        <!-- Specify a CM Environment component Identifier. -->
        <Property Name="CMEnvironmentID">d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613</Property>
        <!-- Specify a Telephony Server component Identifier. -->
        <Property Name="TelSysID">100100</Property>
        <!-- Specify a Partition Identifier within a Telephony Server. -->
        <Property Name="PartIDInTelSys">2</Property>
        <!-- Can be used to list additional parameters of each Akixi Application User. -->
        <Property Name="UserFields">LockOut,ReportingAccess,EnhancedMobileReporting,Admin,
            OmniChannelACDAgent
        </Property>
        <!-- Optional property to list Application Users containing a specific Username or FullName. -->
        <Property Name="SearchQuery">Add Username or FullName to query</Property>
    </OperationPayload>
</Request>

The UserList operation can only return the following Application User configuration entry Properties:

  • Username *
  • FullName *
  • LockOut
  • ReportingAccess
  • EnhancedMobileReporting
  • Admin
  • OmniChannelACDAgent

Parameters marked with an asterisk (*) are returned by default (i.e. it is not required to specify them via the UserFields Property).

# UserList Response

If a UserList operation is successful, then you’ll receive a list of Akixi Application Users and their primary Properties. If additional parameters were not provided within your request, you will receive default Properties of all Users (i.e. Username and FullName values). If additional fields were requested via UserFields Property, then corresponding values will also be returned within the operation’s response. If SearchQuery Payload Property was requested for, then opreation's response will only contain Application Users whose default properties match the search query provided:

<Response Result="Success">
    <InvokeID>00027</InvokeID>
    <Success>
        <Container>
            <!-- Only Username and FullName parameters are returned by default.-->
            <Property Name="Username">supervisor1@example.com</Property>
            <Property Name="FullName">Sample Supervisor Account</Property>
            <!-- Parameters below were requested via UserFields Property.-->
            <Property Name="LockOut">False</Property>
            <Property Name="ReportingAccess">Akixi 2000</Property>
            <Property Name="EnhancedMobileReporting">True</Property>
            <Property Name="Admin">False</Property>
        </Container>
        <Container>
            <!-- Only Username and FullName parameters are returned by default.-->
            <Property Name="Username">administrator@example.com</Property>
            <Property Name="FullName">Sample Admin Account</Property>
            <!-- Parameters below were requested via UserFields Property.-->
            <Property Name="LockOut">False</Property>
            <Property Name="ReportingAccess">Akixi 2000</Property>
            <Property Name="EnhancedMobileReporting">False</Property>
            <Property Name="Admin">True</Property>
            <Property Name="OmniChannelACDAgent">True</Property>
        </Container>
    </Success>
</Response>

If the request was unsuccessful (i.e. the response’s Result attribute depicts the Fail value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10513, 10514, 10515, 10700, 10701, 10702
Telephone Server Component Related Error Codes 11013
Partition Related Error Codes 11131

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

# UserInfo

The UserInfo request can be used to obtain information related to a certain Application User.

# UserInfo Request

Similar to UserDelete operations UserInfo requests are also quite minimalistic – in order to delete a user account, you must simply specify a correct username value:

<Request Operation="UserInfo">
    <InvokeID>00028</InvokeID>
    <SessionID>EFA4902A7F61D03E42BF3222B0A246BF</SessionID>
    <OperationPayload>
        <Property Name="Username">supervisor1@example.com</Property>
    </OperationPayload>
</Request>

# UserInfo Response

When a UserInfo operation is successful, you will receive response similar to the following:

<Response Result="Success">
    <InvokeID>00028</InvokeID>
    <Success>
        <!-- General Properties.-->
        <Property Name="Username">supervisor@example.com</Property>
        <Property Name="EmailAddr">reporting@acme-commsnet.com</Property>
        <Property Name="FullName">Sample Supervisor Account 2</Property>
        <Property Name="LockOut">False</Property>
        <Property Name="PasswordChgRequired">True</Property>
		<Property Name="EnableMFA">False</Property>
        <Property Name="SynchroniseSupervisorPermissions">False</Property>
        <Property Name="Defaultlang">en_GB</Property>
        <!-- Scope-related Properties.-->
        <Container Name="Scope">
            <Property Name="CMEnvironmentID">d6d6c5a5f0f90d60:-15617a00:169f533f6d5:5613</Property>
            <Property Name="TelSysID">100100</Property>
            <Property Name="PartIDInTelSys">2</Property>
            <Property Name="DeviceNumber">All</Property>
            <Property Name="AgentNumber">All</Property>
            <Property Name="ReportingAccess">Akixi 1000</Property>
            <Property Name="Admin">False</Property>
            <Property Name="CallRecIntID">4f124376cc1db4d4:-5629173c:17d7be86775:-7fb6</Property>
            <Property Name="ReportReadOnly">False</Property>
        </Container>
        <!-- User Permission-related Properties -->
        <Container Name="Permissions">
            <Property Name="Admin">Device|Create,ACDAgent|Create,Code|Create,DirectoryEntry|Create,Partition|Create,TelSys|Create,Omnichannel|Create,User|Create,Recording|Create,CME|Create,Device|Read,ACDAgent|Read,Code|Read,DirectoryEntry|Read,Partition|Read,TelSys|Read,Omnichannel|Read,User|Read,Recording|Read,CME|Read,Message|Read,Database|Read,LogMngmt|Read,CallControl|Read,License|Read,Logging|Read,Device|Update,ACDAgent|Update,Code|Update,DirectoryEntry|Update,Partition|Update,TelSys|Update,Omnichannel|Update,User|Update,Recording|Update,CME|Update,Message|Update,Database|Update,LogMngmt|Update,License|Update,Device|Delete,ACDAgent|Delete,Code|Delete,DirectoryEntry|Delete,Partition|Delete,TelSys|Delete,Omnichannel|Delete,User|Delete,Recording|Delete,CME|Delete,Message|Delete,SignInAs,ReportCopy,ChangeTelSysPartitionLicenseLevel,BillingSummary,BillingCDRs,SyncPartition,AuditTrail|Read,TelSysStatus|Read,OmnichannelStatus|Read,ServerStatus|Read</Property>
            <Property Name="NonAdmin">Report|Create,Report|Read,Report|Update,Report|Delete,ReportDataAPI,AdvancedMobileAppFeatures</Property>
            <Property Name="Other">ConcurrentSignIn,ServiceNotifications</Property>
        </Container>
        <!-- Endpoint-related Properties.-->
        <Container Name="Endpoint">
            <Property Name="TelSysID">100100</Property>
            <Property Name="PartIDInTelSys">2</Property>
            <Property Name="DeviceNumber">01234567890</Property>
            <Property Name="AgentNumber">None</Property>
        </Container>
        <!-- Advanced Properties.-->
        <Container Name="Advanced">
            <Property Name="PromptForTerms">False</Property>
            <Property Name="NotifyPasswordChgs">False</Property>
            <Property Name="ReportUpdInterval">Auto</Property>
            <Property Name="DisableMediaPlugIns">False</Property>
            <Property Name="DisableDragDropFeatures">False</Property>
            <Property Name="JavaScriptAuditOutput">False</Property>
        </Container>
    </Success>
</Response>

If the request was unsuccessful (i.e. the response’s Result attribute depicts the Fail value), then the response’s error code and the message description values should be parsed by the client application and then handled accordingly. Some common errors returned by this operation are provided in the table below:

Error Type Error Codes
General Error Codes 10101, 10103
Session Related Error Codes 10301, 10302
Authentication Related Error Codes 10305, 10307, 10313
Permissions Related Error Codes 10511, 10512, 10513, 10514, 10515, 10700, 10701, 10702
User Related Error Codes 11200, 11201

Please refer to the “Error Codes” chapter for further details on specific error codes and their meaning.

← Codes →