Core classes and operations
103
SIPxNano IP-PBX Getting Started Guide
C • Configuration APIs
Edit User
Modifies data for an existing SIPxNano user to match your external source data. To edit a user, you use either:
•
editUser operation in the UserService. See the WSDL user-service.xml file
•
EditUserCommand class in the com.Patton.pds.applications. loader.commands package
Note
If a value is “null”, the value of that field will be set to null in SIPxNano.
userGroupName
setUserGroupName()
Identifies the fully-qualified user group
for the user. You must specify the com-
plete group hierarchy, including the
user group names of both the immedi-
ate parent group and all ancestor
groups, relative to the root of the sys-
tem.
The ancestry is delimited with ’/’ charac-
ters. A leading ’/’ should not be used.
For example, to create a new user in
the sales user group, which in turn
belongs to the (top-level) west coast
user group, supply west coast/sales
(without the quotation marks).
Yes
Table 14. Core Operations: Edit User
WSDL Parameter
Java Method
Description
Required?
existingUserId
setExistingUserId()
Must reference an existing User
ID. See
“Add User”
on page 102.
Yes
newUserId
setNewUserId()
A new user ID for the existing
user. See
“Add User”
on
page 102.
No
PIN
setPIN()
See
“Add User”
on page 102.
No
firstName
setFirstName()
See
“Add User”
on page 102.
No
lastName
setLastName()
See
“Add User”
on page 102.
No
extension
setExtension()
See
“Add User”
on page 102.
No
alias
setAlias()
See
“Add User”
on page 102.
No
userGroupName
setUserGroupName()
See
“Add User”
on page 102.
Yes
Table 13. Core Operations: Add User
WSDL Parameter
Java Method
Description
Required?