Core classes and operations
102
SIPxNano IP-PBX Getting Started Guide
C • Configuration APIs
Core classes and operations
An introduction to the core Java classes and WSDL operations that make up the SIPxNano Configuration
APIs follows.
Note
You can invoke operations from Java using the supplied Java classes. Alterna-
tively, you can access the API from other languages as long as the access con-
forms to the WSDL.
Add User
Creates a new user in SIPxNano from your external source data. To add a user, you use either:
•
createUser operation in the UserService. See the WSDL user-service.xml file
•
AddUserCommand class in the com.Patton.pds.applications. loader.commands package
Table 13. Core Operations: Add User
WSDL Parameter
Java Method
Description
Required?
userId
setId()
Valid strings contain only:
¥ a-z
¥ A-Z
¥ Numbers
¥ Under score(_)
Must be less than 80 characters in
length.
Cannot be a duplicate of an existing
user ID or extension or in the
reserved
extension pool.
Yes
PIN
setPIN()
Valid strings contain only digits from 0
to 9.
No
firstName
setFirstName()
Valid strings contain Unicode charac-
ters between 0000 and 007F and 009F-
00FF.
Must be less than 20 characters in
length.
No
lastName
setLastName()
Valid strings contain Unicode charac-
ters between 0000 and 007F and 009F-
00FF.
Must be less than 30 characters in
length.
No
extension
setExtension()
Valid strings contain only digits from 0
to 9, hyphen (-) characters, or spaces.
Must be less than 30 characters in
length.
Cannot be a duplicate of an existing
user ID or extension or in the
reserved
extension pool.
No
alias
setAlias()
Must be less than 256 characters in
length.
No
