|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DlsAPIv100
The DlsAPI Interface.
Method | deleted since DLS version |
---|---|
getTemplateNames | .HI-DLS.10.211.00. |
Method Summary | |||||
---|---|---|---|---|---|
DlsAPIout |
addUser(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164User,
java.lang.String e164UserPin,
java.lang.String userDataProfile,
java.lang.String ppData)
THIS METHOD IS NOT YET IMPLEMEMNTED AND RETURNS DlsAPIout.DLSAPI_ERROR_NOT_IMPLEMENTED . |
||||
DlsAPIout |
closeSession(java.lang.String sessionRef)
Close a DlsAPI session. |
||||
DlsAPIout |
createClientSessionID(java.lang.String user,
java.lang.String password)
Type: synchronous Get a DLS client session ID for a single usage. |
||||
DlsAPIout |
deviceIdModifyE164(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String deviceId,
java.lang.String newE164)
THIS METHOD IS NOT YET IMPLEMEMNTED AND RETURNS DlsAPIout.DLSAPI_ERROR_NOT_IMPLEMENTED . |
||||
DlsAPIout |
deviceIdModifyHfaSubscriber(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String deviceId,
java.lang.String deviceProfile,
java.lang.String subscriberNumber,
java.lang.String subscriberPassword,
java.lang.String gatekeeperAddress,
java.lang.String gatekeeperPort)
Modify a HFA subscriber based on its deviceId. |
||||
DlsAPIout |
deviceIdModifyMacAddress(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String deviceId,
java.lang.String newMacAddress)
Change the mac address of a virtual device with an explicitely given mac address . |
||||
DlsAPIout |
deviceIdModifySipSubscriber(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String deviceId,
java.lang.String deviceProfile,
java.lang.String terminalName,
java.lang.String sipUserID,
java.lang.String sipPassword,
java.lang.String sipRealm)
Modify a SIP subscriber based on its deviceId. |
||||
DlsAPIout |
deviceIDQuerySubscribers(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String queryType,
java.lang.String deviceIDPattern)
Query DLS inventory DB based on device ID (search pattern). |
||||
SipSubscriberList |
deviceIDQuerySubscribersType02(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String deviceIDPattern)
|
||||
DlsAPIout |
e164AddHfaSubscriber(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164,
java.lang.String deviceProfile,
java.lang.String subscriberNumber,
java.lang.String subscriberPassword,
java.lang.String gatekeeperAddress,
java.lang.String gatekeeperPort,
java.lang.String macAddress)
Add a HFA subscriber based on its e164 number. |
||||
DlsAPIout |
e164AddSipSubscriber(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164,
java.lang.String deviceProfile,
java.lang.String terminalName,
java.lang.String sipUserID,
java.lang.String sipPassword,
java.lang.String sipRealm,
java.lang.String macAddress)
Add a SIP subscriber based on its e164 number. |
||||
DlsAPIout |
e164AddSipSubscriberType02(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164,
java.lang.String deviceProfile,
java.lang.String terminalName,
java.lang.String sipUserID,
java.lang.String sipPassword,
java.lang.String sipRealm,
java.lang.String sipServerAddress,
java.lang.String sipServerPort,
java.lang.String macAddress)
Add a SIP subscriber based on its e164 number. |
||||
DlsAPIout |
e164DeleteSubscriber(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164)
Delete a subscriber based on its e164 number. |
||||
DlsAPIout |
e164DeleteSubscriberList(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String[] e164List)
Delete a list of subscribers based on their e164 numbers. |
||||
DeviceProfileAPIout |
e164GetDeviceProfile(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164)
Reads the last device profile which was applied to the device identifed by e164. |
||||
DeviceAPIout |
e164GetKeyLayout(java.lang.String sessionRef,
java.lang.String e164)
Provides information about key layout and key functions configured for the device. |
||||
DlsAPIout |
e164ModifyE164(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String oldE164,
java.lang.String newE164)
THIS METHOD IS NOT YET IMPLEMEMNTED AND RETURNS DlsAPIout.DLSAPI_ERROR_NOT_IMPLEMENTED . |
||||
DlsAPIout |
e164ModifyHfaSubscriber(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164,
java.lang.String deviceProfile,
java.lang.String subscriberNumber,
java.lang.String subscriberPassword,
java.lang.String gatekeeperAddress,
java.lang.String gatekeeperPort)
Modify a HFA subscriber based on its e164 number. |
||||
DeviceAPIout |
e164ModifyKeyLayout(java.lang.String sessionRef,
java.lang.String orderId,
Device device)
Key layout and key functions for the device are configured based on the e164 number. |
||||
DlsAPIout |
e164ModifyMacAddress(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164,
java.lang.String newMacAddress)
Type: synchronous | History of change: | DLS version | Change | .HI-DLS.10.300.00. |
DlsAPIout |
e164ModifySipSubscriber(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164,
java.lang.String deviceProfile,
java.lang.String terminalName,
java.lang.String sipUserID,
java.lang.String sipPassword,
java.lang.String sipRealm)
Modify a SIP subscriber based on its e164 number. |
||||
DlsAPIout |
e164ModifySipSubscriberType02(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164,
java.lang.String deviceProfile,
java.lang.String terminalName,
java.lang.String sipUserID,
java.lang.String sipPassword,
java.lang.String sipRealm,
java.lang.String sipServerAddress,
java.lang.String sipServerPort)
THIS METHOD IS NOT YET IMPLEMEMNTED AND RETURNS DlsAPIout.DLSAPI_ERROR_NOT_IMPLEMENTED . |
||||
DlsAPIout |
e164QuerySubscribers(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String queryType,
java.lang.String e164Pattern)
Query DLS inventory DB based on e164 number (search pattern). |
||||
SipSubscriberList |
e164QuerySubscribersType01(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164Pattern)
This method does essentialy the same as e164QuerySubscribers(String, String, String, String)
with queryType=01. |
||||
SipSubscriberList |
e164QuerySubscribersType02(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164Pattern)
This method does essentialy the same as e164QuerySubscribers(String, String, String, String)
with queryType=02. |
||||
DlsAPIout |
gatewayStartupNotification(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String gatewayIpAddress)
Notify DLS about gateway startup. |
||||
java.lang.String |
getApiServerVersionString()
Get the version of the DlsAPI. |
||||
DeviceDescriptionAPIout |
getDeviceDescriptions(java.lang.String sessionRef)
This method returns master data of devices suported by DLS (i.e. device type, modules, level and keys). |
||||
java.lang.String |
getDlsServerVersionString()
Get the version of the DLS server. |
||||
FunctionDescriptionAPIout |
getFunctionDescriptions(java.lang.String sessionRef,
java.lang.String deviceType,
int level,
java.lang.String softwareType,
java.lang.String softwareVersion)
Key function descriptions are stable throughout a DLS release. |
||||
LayoutDescriptionAPIout |
getLayoutDescription(java.lang.String sessionRef,
java.lang.String deviceType,
java.lang.String softwareType,
java.lang.String softwareVersion)
Key layout descriptions are stable throughout a DLS release. |
||||
DlsAPIout |
getStatusOfRequestID(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String requestID)
Get status of an asynchronously started request (i.e. a request that returned DlsAPIout.DLSAPI_OK_RUNNING ). |
||||
DlsAPIout |
getStatusOfRequestIDs(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String whatOrderID,
java.lang.String whatUser,
java.lang.String whatStatus)
Get status of asynchronously started requests (i.e. all requests that returned DlsAPIout.DLSAPI_OK_RUNNING ) including their current
status. |
||||
DlsAPIout |
listDeviceProfiles(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String pattern)
List all device profiles names currently configured in DLS. |
||||
DlsAPIout |
mobileUserLogoff(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String timeout,
java.lang.String e164User,
java.lang.String e164UserPin)
Logoff a mobile user from a mobility-enabled phone. |
||||
DlsAPIout |
mobileUserLogon(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String timeout,
java.lang.String e164User,
java.lang.String e164UserPin,
java.lang.String e164Basic)
Logon a mobile user to a mobility-enabled phone. |
||||
DlsAPIout |
mobileUserModifyTerminalName(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164User,
java.lang.String terminalName)
Modify the terminal name of a mobile user. |
||||
DlsAPIout |
mobileUserSearch(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164User)
Return mobility-enabled phone(s), the mobile user is currently logged on. |
||||
DlsAPIout |
mobileUserStatus(java.lang.String sessionRef,
java.lang.String orderID,
java.lang.String e164Basic)
Return current mobility status of a mobility-enabled phone. |
||||
DlsAPIout |
openSession(java.lang.String user,
java.lang.String password)
Open a DlsAPI session. |
Method Detail |
---|
java.lang.String getApiServerVersionString()
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
java.lang.String getDlsServerVersionString()
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
Type: synchronous
DlsAPIout openSession(java.lang.String user, java.lang.String password)
DlsAPIout.result
is a required
input parameter ('sessionRef').
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
user
- The user name.password
- The user password.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
: The session was
opened successfully and DlsAPIout.result
is the session
identifier to be submitted with subsequent DlsAPI method calls.DlsAPIout.DLSAPI_ERROR_INVALID_LOGON
: The session
could not be opened and DlsAPIout.result
does not contain
any valid session identifier.DlsAPIout closeSession(java.lang.String sessionRef)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
: The session was
closed successfully. The session identifier is no longer valid.DlsAPIout.DLSAPI_ERROR_INVALID_SESSION
:
'sessionRef' does not identify a valid session.DlsAPIout createClientSessionID(java.lang.String user, java.lang.String password)
Type: synchronous
Get a DLS client session ID for a single usage. The ID is valid only for 100 seconds. The DLS client session ID can be used to start a DLS client via URL
http://[DLS_HOST]:[DLS_PORT]/DeploymentService/index.html?session=[CLIENT_SESSION_ID]&e164=4989722987654.
DLS client then automatically logs on to DLS server with user and password passed to this method.
It is not guaranteed that the returned client session ID is valid. Even if e.g. user or password are invalid a client session ID will be created (so that it is not to easy to find out the password for a known user by brute force). But then calling DLS client with this client session ID will fail and DLS client will present its login screen so that the user can submit correct data.
The client session ID expires in following cases:
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.216.00. | created and impelemented | |
.HI-DLS.10.218.00. | parameter sessionRef removed |
user
- DLS client user.password
- DLS client password.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
: A client session ID was created. Note that even in this case
it is not guaranteed that a logon to the DLS client will be successful.
DlsAPIout.DLSAPI_ERROR_FATAL
:
Due to technical problems a client session id could not be created..
DlsAPIout.result
contains the client session id. Note that it is not guaranteed that a logon
to the DLS client will be successful, even if a client session id is created.DlsAPIout getStatusOfRequestIDs(java.lang.String sessionRef, java.lang.String orderID, java.lang.String whatOrderID, java.lang.String whatUser, java.lang.String whatStatus)
DlsAPIout.DLSAPI_OK_RUNNING
) including their current
status.
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)whatOrderID
- optional - if given, only requests associated with this
orderID are listedwhatUser
- optional - if given, only requests started by this user are
listedwhatStatus
- optional - if given, only requests whose current status
matches with whatStatus are listed
DlsAPIout.status
can have one of the following values:
DlsAPIout.result
)DlsAPIout.result
is empty.
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No request that matches
the given search criteria(s) were found in DLS DB.
DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: e.g. whatUser
contains unknown user
DlsAPIout.result
is formatted as follows:DlsAPIout getStatusOfRequestID(java.lang.String sessionRef, java.lang.String orderID, java.lang.String requestID)
DlsAPIout.DLSAPI_OK_RUNNING
).
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)requestID
- a single requestID as returned by a previous DlsAPI request.DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
: The requested status
information is supplied via DlsAPIout.result
.DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: A request with
'requestID' could not be found in DLS DB.DlsAPIout listDeviceProfiles(java.lang.String sessionRef, java.lang.String orderID, java.lang.String pattern)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | created and implemented | |
.HI-DLS.10.212.00. | Name changed from 'listTemplateNames' to 'listDeviceProfiles'. |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)pattern
- if given, restricts the list of returned device profile names to those that
match 'pattern'
DlsAPIout.status
can have one of the following values:
DlsAPIout.result
)DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No request that matches
the given pattern found in DLS DB.DlsAPIout.result
contains all device profile names, separated by
newline characters, i.e.:DlsAPIout e164AddSipSubscriber(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164, java.lang.String deviceProfile, java.lang.String terminalName, java.lang.String sipUserID, java.lang.String sipPassword, java.lang.String sipRealm, java.lang.String macAddress)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164
- The e164 number of the device to be added. A device with given e164 number
must not yet exist.deviceProfile
- The device profile containing the PnP data.terminalName
- Terminal name of the device.
This is the name of the phone as it registers with the SIP registrar server.
If not set, the phone uses its E164 number for registration.sipUserID
- User ID to be used by the device to register at the SIP serversipPassword
- Password to be used by the device to register at the SIP serversipRealm
- Realm to be used by the device to register at the SIP servermacAddress
- Mac address of the device to be added. If not empty, a device with this mac address must not yet exists.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
:
A new virtual device is added to DLS.DlsAPIout.DLSAPI_ERROR_AMBIGUOUS
: A device is already configured
for this e164 number or this macAddress.DlsAPIout.DLSAPI_ERROR_VERIFY
DlsAPIout e164AddSipSubscriberType02(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164, java.lang.String deviceProfile, java.lang.String terminalName, java.lang.String sipUserID, java.lang.String sipPassword, java.lang.String sipRealm, java.lang.String sipServerAddress, java.lang.String sipServerPort, java.lang.String macAddress)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.246.00. | method added, not yet implemented | |
.HI-DLS.10.246.00. | method name changed from e164AddSipSubscriber to e164AddSipSubscriberType02 |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164
- The e164 number of the device to be added. A device with given e164 number
must not yet exist.deviceProfile
- The device profile containing the PnP data.terminalName
- Terminal name of the device.
This is the name of the phone as it registers with the SIP registrar server.
If not set, the phone uses its E164 number for registration.sipUserID
- User ID to be used by the device to register at the SIP serversipPassword
- Password to be used by the device to register at the SIP serversipRealm
- Realm to be used by the device to register at the SIP serversipServerAddress
- SIP server IP address or hostnamesipServerPort
- SIP server portmacAddress
- Mac address of the device to be added. If not empty, a device with this mac address must not yet exists.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
:
A new virtual device is added to DLS.DlsAPIout.DLSAPI_ERROR_AMBIGUOUS
: A device is already configured
for this e164 number or this macAddress.DlsAPIout.DLSAPI_ERROR_VERIFY
DlsAPIout e164AddHfaSubscriber(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164, java.lang.String deviceProfile, java.lang.String subscriberNumber, java.lang.String subscriberPassword, java.lang.String gatekeeperAddress, java.lang.String gatekeeperPort, java.lang.String macAddress)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.203.00. | created, not yet implemented | |
.HI-DLS.10.300.00. | implemented | |
.HI-DLS.10.301.00. | Parameter gatekeeperPort added |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164
- The e164 number of the device to be added.deviceProfile
- The device profile containing the PnP data.subscriberNumber
- Subscriber number of the device used to register at the gatekeeper.subscriberPassword
- Password to be used by the device to register at the gatekeeper.gatekeeperAddress
- IP address of the gatekeeper (equal to gateway IP address).gatekeeperPort
- Port of the gatekeepermacAddress
- Mac address of the device to be added. If not empty, a device with this mac address must not yet exists.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
:
A new virtual device is added to DLS.DlsAPIout.DLSAPI_ERROR_VERIFY
DlsAPIout e164ModifyE164(java.lang.String sessionRef, java.lang.String orderID, java.lang.String oldE164, java.lang.String newE164)
THIS METHOD IS NOT YET IMPLEMEMNTED AND RETURNS DlsAPIout.DLSAPI_ERROR_NOT_IMPLEMENTED
.
Type: asynchronous & synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.203.00. | created |
sessionRef
- A valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- Transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)oldE164
- All devices with old e164 number will be given the new e164 number, with one
restriction: The resulting set of devices with new e164 number must not contain
more than one virtual device without mac address.newE164
- The new e164 number for the given subscriber(s).
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: If 'oldE164' or 'newE164' is not a valid e164 format.DlsAPIout.DLSAPI_OK_BOUNDARY
: All device with given 'oldE164' are virtual, and
the resulting set of devices with new e164 number does not contain
more than one virtual device without mac address.
DlsAPIout.DLSAPI_OK_RUNNING
: At least one device with given 'oldE164' is registered, and
the resulting set of devices with new e164 number does not contain
more than one virtual device without mac address.
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No device with
given e164 could be found in DLS DB.DlsAPIout.DLSAPI_ERROR_AMBIGUOUS
: The resulting set of devices with new e164 number
contains more than one virtual device without mac address.DlsAPIout.DLSAPI_ERROR_INVALID_OBJECT
: At least one device with given 'oldE164'
is not an IP phone (e.g. an IP client or an IP gateway).DlsAPIout deviceIdModifyE164(java.lang.String sessionRef, java.lang.String orderID, java.lang.String deviceId, java.lang.String newE164)
THIS METHOD IS NOT YET IMPLEMEMNTED AND RETURNS DlsAPIout.DLSAPI_ERROR_NOT_IMPLEMENTED
.
Type: asynchronous & synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.203.00. | created |
sessionRef
- A valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- Transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)deviceId
- The deviceId of the device which should be given the new e164.newE164
- The new e164 number for the given subscriber(s).
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: If 'deviceId' is not a valid mac address format
or 'newE164' is not a valid e164 format.DlsAPIout.DLSAPI_OK_BOUNDARY
: The device with given 'deviceId' is virtual, and
the resulting set of devices with new e164 number does not contain
more than one virtual device without mac address.
DlsAPIout.DLSAPI_OK_RUNNING
: The device with given 'deviceId' is registered.
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No device with given 'deviceId' could be found in DLS DB.DlsAPIout.DLSAPI_ERROR_AMBIGUOUS
: The resulting set of devices with new e164 number
contains more than one virtual device without mac address.DlsAPIout.DLSAPI_ERROR_INVALID_OBJECT
: The device with given 'deviceId'
is not an IP phone (e.g. an IP client or an IP gateway).DlsAPIout e164ModifyMacAddress(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164, java.lang.String newMacAddress)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.300.00. | created and implemented |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164
- The e164 number of the device to modify. 'e164' must identify a single
virtual sip or hfa device.newMacAddress
- The new mac address for the given subscriber.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: If 'e164' is not a valid e164 format or 'newMacAddress' is not a valid mac-address format.DlsAPIout.DLSAPI_OK_BOUNDARY
: Exactly one virtual device with given 'e164' was found
and another device which has newMacAddress as deviceId does not exist.
DlsAPIout.DLSAPI_ERROR_ALREADY_EXISTS
: Exactly one virtual device with given 'e164' was found, but
another device which has newMacAddress as deviceId already exists.
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No device with
given e164 could be found in DLS DB.DlsAPIout.DLSAPI_ERROR_AMBIGUOUS
: More than one device with given e164 number can be found.DlsAPIout#DLSAPI_ERROR_IS_REGISTSERED_DEVICE
: The 'e164' corresponds to exactly one registered device.DlsAPIout.DLSAPI_ERROR_INVALID_OBJECT
: At least one device with given 'e164'
is not an IP phone (e.g. an IP client or an IP gateway).DlsAPIout deviceIdModifyMacAddress(java.lang.String sessionRef, java.lang.String orderID, java.lang.String deviceId, java.lang.String newMacAddress)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.300.00. | created and implemented |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)deviceId
- The deviceId of the device to modify. 'deviceId' must be a mac-address and it must identify a
virtual sip or hfa device.newMacAddress
- The new mac address for the given subscriber.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
At least one of 'deviceId' or 'newMacAddress' is not a valid mac-address format.DlsAPIout.DLSAPI_OK_BOUNDARY
: A virtual device with given 'deviceId' was found
and another device which has newMacAddress as deviceId does not exist.
DlsAPIout.DLSAPI_ERROR_ALREADY_EXISTS
: A virtual device with given 'deviceId' was found, but
another device which has newMacAddress as deviceId already exists.
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No device with
the given deviceId could be found in DLS DB.DlsAPIout#DLSAPI_ERROR_IS_REGISTSERED_DEVICE
: The 'deviceId' corresponds to a registered device.DlsAPIout.DLSAPI_ERROR_INVALID_OBJECT
: The 'deviceId' corresponds to a virtual device,
which is not an IP phone (e.g. to an IP client or an IP gateway).DlsAPIout e164ModifySipSubscriber(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164, java.lang.String deviceProfile, java.lang.String terminalName, java.lang.String sipUserID, java.lang.String sipPassword, java.lang.String sipRealm)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.239.00. | Support for multiple devices with identical e164. | |
.HI-DLS.10.196.00. | history started |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164
- e164 of the SIP subscriber to modify. e164 has to be the basic e164 of one ore more
SIP IP Phones.deviceProfile
- -
add/update in inventoryterminalName
- Terminal name of the devicesipUserID
- User ID to be used by the device to register at the SIP serversipPassword
- Password to be used by the device to register at the SIP serversipRealm
- Realm to be used by the device to register at the SIP server
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_RUNNING
: At least one modification job for one
of the devices found is started to run asynchronously.
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No device with
the given e164 was found in DLS DB.DlsAPIout.DLSAPI_ERROR_INVALID_OBJECT
:
At least one of the devices found is not a SIP IP Phone.DlsAPIout.DLSAPI_ERROR_BUSY
: At least one of the devices found has currently a user logged on.DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: None of the other status applies, but the
modification parameters are invalid.DlsAPIout.status
= DlsAPIout.DLSAPI_OK_RUNNING
:
DlsAPIout.result
contains the (comma-separated list of) deviceIDs
that were found.
DlsAPIout.requestID
contains the (comma-separated list of) requestIDs
that are associated with the devices. The n-th requestID in the list corresponds to the n-th
deviceID in DlsAPIout.result
.
The current status of these requests can be retrieved using getStatusOfRequestID(java.lang.String, java.lang.String, java.lang.String)
.
DlsAPIout e164ModifySipSubscriberType02(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164, java.lang.String deviceProfile, java.lang.String terminalName, java.lang.String sipUserID, java.lang.String sipPassword, java.lang.String sipRealm, java.lang.String sipServerAddress, java.lang.String sipServerPort)
THIS METHOD IS NOT YET IMPLEMEMNTED AND RETURNS DlsAPIout.DLSAPI_ERROR_NOT_IMPLEMENTED
.
Type: asynchronous & synchronous
History of change: | DLS version | Change | |
---|---|---|---|
.HI-DLS.10.246.00. | created, not yet implemented. | method name changed from e164ModifySipSubscriber to e164ModifySipSubscriberType02 |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164
- e164 of the SIP subscriber to modify. e164 has to be the basic e164 of one ore more
SIP IP Phones.deviceProfile
- -
add/update in inventoryterminalName
- Terminal name of the devicesipUserID
- User ID to be used by the device to register at the SIP serversipPassword
- Password to be used by the device to register at the SIP serversipRealm
- Realm to be used by the device to register at the SIP serversipServerAddress
- SIP server IP address or hostnamesipServerPort
- SIP server port
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_RUNNING
: At least one modification job for one
of the devices found is started to run asynchronously.
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No device with
the given e164 was found in DLS DB.DlsAPIout.DLSAPI_ERROR_INVALID_OBJECT
:
At least one of the devices found is not a SIP IP Phone.DlsAPIout.DLSAPI_ERROR_BUSY
: At least one of the devices found has currently a user logged on.DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: None of the other status applies, but the
modification parameters are invalid.DlsAPIout.status
= DlsAPIout.DLSAPI_OK_RUNNING
:
DlsAPIout.result
contains the (comma-separated list of) deviceIDs
that were found.
DlsAPIout.requestID
contains the (comma-separated list of) requestIDs
that are associated with the devices. The n-th requestID in the list corresponds to the n-th
deviceID in DlsAPIout.result
.
The current status of these requests can be retrieved using getStatusOfRequestID(java.lang.String, java.lang.String, java.lang.String)
.
DlsAPIout deviceIdModifySipSubscriber(java.lang.String sessionRef, java.lang.String orderID, java.lang.String deviceId, java.lang.String deviceProfile, java.lang.String terminalName, java.lang.String sipUserID, java.lang.String sipPassword, java.lang.String sipRealm)
Type: asynchronous & synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.238.00. | created |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)deviceId
- deviceId of the device to modify. deviceId must identify a
sip device. If no device with given deviceId is found, no modification is done.deviceProfile
- -
add/update in inventoryterminalName
- Terminal name of the devicesipUserID
- User ID to be used by the device to register at the SIP serversipPassword
- Password to be used by the device to register at the SIP serversipRealm
- Realm to be used by the device to register at the SIP server
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No device with
the given deviceId found in DLS DB.DlsAPIout.DLSAPI_OK_RUNNING
: asynchronous return;
data has been updated in DLS Plug&Play and jobs have been created
to modify the existing device.DlsAPIout.DLSAPI_ERROR_INVALID_OBJECT
: if e.g. HFA
device corresponds to the given deviceIdDlsAPIout.DLSAPI_ERROR_VERIFY
DlsAPIout.result
contains
the (comma-separated list of) requestID(s) that is associated with
the job(s) created by DLS for that device. The current status of these
jobs can be retrieved using getStatusOfRequestID(java.lang.String, java.lang.String, java.lang.String)
.DeviceDescriptionAPIout getDeviceDescriptions(java.lang.String sessionRef)
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.206.00. | created | |
.HI-DLS.10.208.00. | implemented |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
DeviceDescription
for a detailled description.FunctionDescriptionAPIout getFunctionDescriptions(java.lang.String sessionRef, java.lang.String deviceType, int level, java.lang.String softwareType, java.lang.String softwareVersion)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.206.00. | created | |
.HI-DLS.10.208.00. | implemented |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
deviceType
- The devic type, e.g. "optiPoint 420 economy plus". The device type has to be equal to
DeviceDescription.getDeviceType()
for one of
the device descriptions returned by getDeviceDescriptions(String)
.level
- The level number.softwareType
- The software type, e.g. "Siemens HFA". Software type has to be equal one of the
software types given by
DeviceDescription.getSoftwareTypes()
.softwareVersion
- The software version must have the form x.y.z where
x, y and z are non-negative numbers. If software version '0.0.0' is supplied all
functions for the given 'softwareType' will be returned. If x,y or z are positive
numbers only the functions supported by the given software version are returned.
LayoutDescriptionAPIout getLayoutDescription(java.lang.String sessionRef, java.lang.String deviceType, java.lang.String softwareType, java.lang.String softwareVersion)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.211.00. | created and implemented |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
deviceType
- The devic type, e.g. "optiPoint 420 economy plus". The device type has to be equal to
DeviceDescription.getDeviceType()
for one of
the device descriptions returned by getDeviceDescriptions(String)
.softwareType
- The software type, e.g. "Siemens HFA". Software type has to be equal one of the
software types given by
DeviceDescription.getSoftwareTypes()
.softwareVersion
- The software version must have the form x.y.z where
x, y and z are non-negative numbers. If software version '0.0.0' is supplied all
functions for the given 'softwareType' will be returned. If x,y or z are positive
numbers only the functions supported by the given software version are returned.
DeviceAPIout e164GetKeyLayout(java.lang.String sessionRef, java.lang.String e164)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.206.00. | created | |
.HI-DLS.10.208.00. | implemented |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
e164
- The e164 number identifying a registered device, a virtual device or a mobile user.
DeviceAPIout e164ModifyKeyLayout(java.lang.String sessionRef, java.lang.String orderId, Device device)
getFunctionDescriptions(String, String, int, String, String)
then it
is guaranteed that DLS tries to configure that key function.e164GetKeyLayout(String, String)
.
Type: asynchronous & synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.206.00. | created | |
.HI-DLS.10.208.00. | implemented | |
.HI-DLS.10.210.00. | Name changed from 'setSipKeys' to 'e164ModifyKeyLayout'. |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderId
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)device
- The device which should be configured. The device is identifed by its e164 number.
DlsAPIout e164ModifyHfaSubscriber(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164, java.lang.String deviceProfile, java.lang.String subscriberNumber, java.lang.String subscriberPassword, java.lang.String gatekeeperAddress, java.lang.String gatekeeperPort)
Type: asynchronous & synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.203.00. | created, not yet implemented | |
.HI-DLS.10.300.00. | implemented | |
.HI-DLS.10.301.00. | Parameter gatekeeperPort added |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164
- error if more than one wp in inventory;
if not exists in inventory, pnp data is updated only
(incl. set of pnp flags) - note that templateName is ignored
in this casedeviceProfile
- -
add/update in inventorysubscriberNumber
- Subscriber number of the device used to register at the gatekeepersubscriberPassword
- Password to be used by the device to register at the gatekeepergatekeeperAddress
- IP address of the gatekeepergatekeeperPort
- Port of the gatekeeper
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No device with
the given e164 found in DLS DB.DlsAPIout.DLSAPI_OK_RUNNING
: asynchronous return;
data has been updated in DLS Plug&Play and jobs have been created
to modify the existing device.DlsAPIout.DLSAPI_ERROR_INVALID_OBJECT
: if e.g. SIP
device is configured for this e164 numberDlsAPIout.DLSAPI_ERROR_VERIFY
DlsAPIout.result
contains
the (comma-separated list of) requestID(s) that is associated with
the job(s) created by DLS for that device. The current status of these
jobs can be retrieved using getStatusOfRequestID(java.lang.String, java.lang.String, java.lang.String)
.DlsAPIout deviceIdModifyHfaSubscriber(java.lang.String sessionRef, java.lang.String orderID, java.lang.String deviceId, java.lang.String deviceProfile, java.lang.String subscriberNumber, java.lang.String subscriberPassword, java.lang.String gatekeeperAddress, java.lang.String gatekeeperPort)
Type: asynchronous & synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.238.00. | created, not yet implemented | |
.HI-DLS.10.300.00. | implemented | |
.HI-DLS.10.301.00. | Parameter gatekeeperPort added |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)deviceId
- deviceId of the device to modify. deviceId must identify an
hfa device. If no device with given deviceId is found, no modification is done.deviceProfile
- -
add/update in inventorysubscriberNumber
- Subscriber number of the device used to register at the gatekeepersubscriberPassword
- Password to be used by the device to register at the gatekeepergatekeeperAddress
- IP address of the gatekeepergatekeeperPort
- Port of the gatekeeper
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: No device with
the given deviceId found in DLS DB.DlsAPIout.DLSAPI_OK_RUNNING
: asynchronous return;
data has been updated in DLS Plug&Play and jobs have been created
to modify the existing device.DlsAPIout.DLSAPI_ERROR_INVALID_OBJECT
: if e.g. SIP
device corresponds to the given deviceIdDlsAPIout.DLSAPI_ERROR_VERIFY
DlsAPIout.result
contains
the (comma-separated list of) requestID(s) that is associated with
the job(s) created by DLS for that device. The current status of these
jobs can be retrieved using getStatusOfRequestID(java.lang.String, java.lang.String, java.lang.String)
.DlsAPIout e164DeleteSubscriber(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started | |
.HI-DLS.10.203.00. | Parameter 'ppOnly' added. | |
.HI-DLS.10.212.00. | Parameter 'ppOnly' removed. |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164
- All entries of the given e164 number are deleted in DLS
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: e164 not found in
inventory DBDlsAPIout e164DeleteSubscriberList(java.lang.String sessionRef, java.lang.String orderID, java.lang.String[] e164List)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.211.00. | created and implemented | |
.HI-DLS.10.212.00. | Parameter 'ppOnly' removed. |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164List
- All entries of the given e164 numbers are deleted in DLS
DlsAPIout.getStatus()
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
: All supscribers were found and have been
succesfully deleted.DlsAPIout.DLSAPI_ERROR_FAILED
: At least one subscriber could not be deleted.
See DlsAPIout.getResult()
for detailled information.DlsAPIout.getResult()
is a comma-separated list with one entry for each supplied
e164 number. Each entry has the form 'e164:message', where 'message' contains information about
the deletion status of the respective sip subscriber.DeviceProfileAPIout e164GetDeviceProfile(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.212.00. | created | |
.HI-DLS.10.216.00. | implemented | |
.HI-DLS.10.219.00. | Returns time when last plug & play was performed. |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164
- e164 of the device for which the device profiel should be read.
DlsAPIout.getStatus()
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
: A unique device with given e164 was found.DlsAPIout.DLSAPI_ERROR_AMBIGUOUS
: More than one device with given e164 was found.DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: A device with given e164 could not be found.DeviceProfileAPIout.getDeviceProfileName()
is the last device profile name which was applied to the device.
DeviceProfileAPIout.getTimeInMillis()()
is the date and time when the plug & play for the device
was performed (as number of milliseconds since the Epoch '1970-01-01 0:00 GMT').
If no device profile was applied to the given device, device profile name is empty and time in millis is '0'.DlsAPIout e164QuerySubscribers(java.lang.String sessionRef, java.lang.String orderID, java.lang.String queryType, java.lang.String e164Pattern)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)queryType
- Defines what device attributes are to be returned in DlsAPIout.result
.e164Pattern
- if given, restricts the list of returned devices to those that
match 'e164pattern'
DlsAPIout.status
can have one of the following values:
DlsAPIout.result
)DlsAPIout.result
is empty.
DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: e.g. unknown queryType,
or e164Pattern is not accepted
DlsAPIout.result
is formatted as follows:SipSubscriberList e164QuerySubscribersType01(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164Pattern)
e164QuerySubscribers(String, String, String, String)
with queryType=01. The main difference is the return type: This method returns a list of typed
sip subscriber data. Note that (for large lists) this method is slower than
e164QuerySubscribers(String, String, String, String)
.
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.202.00. | created and implemented |
sessionRef
- see e164QuerySubscribers(String, String, String, String)
orderID
- see e164QuerySubscribers(String, String, String, String)
e164Pattern
- see e164QuerySubscribers(String, String, String, String)
SipSubscriberData
values will be set for each result in the list:
e164, deviveId, deviceType, swType, swVersion, lastRegistration.
Since the list is also of type DlsAPIout
refer to e164QuerySubscribers(String, String, String, String)
for a decription of
DlsAPIout values (except DlsAPIout.result).SipSubscriberList e164QuerySubscribersType02(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164Pattern)
e164QuerySubscribers(String, String, String, String)
with queryType=02. The main difference is the return type: This method returns a list of typed
sip subscriber data. Note that (for large lists) this method is slower than
e164QuerySubscribers(String, String, String, String)
.
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.202.00. | created and implemented |
sessionRef
- see e164QuerySubscribers(String, String, String, String)
orderID
- see e164QuerySubscribers(String, String, String, String)
e164Pattern
- see e164QuerySubscribers(String, String, String, String)
SipSubscriberData
values will be set for each result in the list:
e164, deviveId, ipAddress, displayId.
Since the list is also of type DlsAPIout
refer to e164QuerySubscribers(String, String, String, String)
for a decription of
DlsAPIout values (except DlsAPIout.result).DlsAPIout deviceIDQuerySubscribers(java.lang.String sessionRef, java.lang.String orderID, java.lang.String queryType, java.lang.String deviceIDPattern)
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.200.00. | created and implemented |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)queryType
- Defines what device attributes are to be returned in DlsAPIout.result
.deviceIDPattern
- if given, restricts the list of returned devices to those that
match 'deviceIDpattern'
DlsAPIout.status
can have one of the following values:
DlsAPIout.result
)DlsAPIout.result
is empty.
DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: e.g. unknown queryType,
or e164Pattern is not accepted
DlsAPIout.result
is formatted as follows:SipSubscriberList deviceIDQuerySubscribersType02(java.lang.String sessionRef, java.lang.String orderID, java.lang.String deviceIDPattern)
DlsAPIout gatewayStartupNotification(java.lang.String sessionRef, java.lang.String orderID, java.lang.String gatewayIpAddress)
Type: asynchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)gatewayIpAddress
- IP Address of the affected gateway
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_RUNNING
:
(the requestID can be found in DlsAPIout.result
)DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: e.g. invalid gatewayIpAddressDlsAPIout.DLSAPI_ERROR_NOT_FOUND
: gateway with given IP address
not configured in DLS.DlsAPIout.result
contains the requestID that is associated with
the job created by DLS for that gateway. The current status of the
job can be retrieved using getStatusOfRequestID(java.lang.String, java.lang.String, java.lang.String)
.DlsAPIout mobileUserLogon(java.lang.String sessionRef, java.lang.String orderID, java.lang.String timeout, java.lang.String e164User, java.lang.String e164UserPin, java.lang.String e164Basic)
Logon a mobile user to a mobility-enabled phone.
Type: pseudo-synchronous or asynchronous (depending on timeout parameter)
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | method added, not yet implemented |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)timeout
- timeout (in seconds) if set to 0, the method is executed
asynchronously (OK_RUNNING is returned and the appropriate
reqestID in status) if set to value greater than 0, the method
returns latest after the given timeout; if the request has not
been completed, ERROR_TIMEOUT is returnede164User
- The mobile users e164 number.e164UserPin
- This parameter is for future use and is currently ignored.e164Basic
- The e164 basic number of the phone the mobile user should be
logged on.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: An invalid parameter was submittedDlsAPIout.DLSAPI_OK_BOUNDARY
: Logon was performed successfully wihtout exceeding timeout.
DlsAPIout.DLSAPI_ERROR_TIMEOUT
: Logon could not be performed without exceeding timeout.
not configured in DLS.DlsAPIout.requestID
is set if logon could not be perfomred wirthout exceeding the timeout.DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: An invalid parameter was submittedDlsAPIout.DLSAPI_OK_RUNNING
: Logon job is started.
DlsAPIout.requestID
represents the job performing an asynchronous logon.DlsAPIout mobileUserLogoff(java.lang.String sessionRef, java.lang.String orderID, java.lang.String timeout, java.lang.String e164User, java.lang.String e164UserPin)
Logoff a mobile user from a mobility-enabled phone.
Type: pseudo-synchronous or asynchronous (depending on timeout parameter)
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)timeout
- timeout (in seconds) if set to 0, the method is executed
asynchronously (OK_RUNNING is returned and the appropriate
reqestID in status) if set to value greater than 0, the method
returns latest after the given timeout; if the request has not
been completed, ERROR_TIMEOUT is returnede164User
- The mobile users e164 number.e164UserPin
- This parameter is for future use and is currently ignored.
mobileUserLogon(String, String, String, String, String, String)
DlsAPIout mobileUserStatus(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164Basic)
Return current mobility status of a mobility-enabled phone.
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.196.00. | history started | |
.HI-DLS.10.236.00. | no change, but documentation added |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of them)e164Basic
- The e164 basic number of a mobility-enabled phone.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
: A mobile user is currently logged on.
(The user's e164 number can be found in DlsAPIout.result
)DlsAPIout.DLSAPI_ERROR_NOT_LOGGED_ON
: No mobile user is currently logged on.DlsAPIout.DLSAPI_ERROR_NOT_MOBILITY_ENABLED
: requested e164 is not a mobility-enabled phone.DlsAPIout mobileUserSearch(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164User)
Return mobility-enabled phone(s), the mobile user is currently logged on.
Type: synchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.246.00. | method added, but not yet implemented |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of them)e164User
- The e164 number of a mobile user.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_BOUNDARY
: The mobile user is currently logged on.
(The basic e164 number of the phone can be found in DlsAPIout.result
)DlsAPIout.DLSAPI_ERROR_NOT_LOGGED_ON
: The mobile user is currently not logged on.DlsAPIout.DLSAPI_ERROR_AMBIGUOUS
: The mobile user is currently logged on at more than one phone.
(The basic e164 numbers of the phones can be found in DlsAPIout.result
) as comma separated list.DlsAPIout mobileUserModifyTerminalName(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164User, java.lang.String terminalName)
Modify the terminal name of a mobile user. If the mobile is currently logged on to a device, a job will be created to inform the device about the new terminal name. In this case the method is executed asynchronously. If the mobile is currently not logged on the mobile user data are updated synchronously.
Type: synchronous & asynchronous
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.216.00. | created and implemented |
sessionRef
- A valid session reference obtained through
openSession(java.lang.String, java.lang.String)
.orderID
- Transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them).e164User
- The mobile user e164 number.terminalName
- The new terminal name.
DlsAPIout.status
can have one of the following values:
DlsAPIout.DLSAPI_OK_RUNNING
: If the mobile user is logged on to a device.
(the requestID can be found in DlsAPIout.result
)DlsAPIout.DLSAPI_ERROR_INVALID_PARAM
: Invalid e164User number.DlsAPIout.DLSAPI_ERROR_NOT_FOUND
: Mobile user with given e164 could not be found.DlsAPIout.result
contains the requestID that is associated with the job created by DLS for that device.
The current status of the job can be retrieved using getStatusOfRequestID(java.lang.String, java.lang.String, java.lang.String)
.DlsAPIout addUser(java.lang.String sessionRef, java.lang.String orderID, java.lang.String e164User, java.lang.String e164UserPin, java.lang.String userDataProfile, java.lang.String ppData)
THIS METHOD IS NOT YET IMPLEMEMNTED AND RETURNS DlsAPIout.DLSAPI_ERROR_NOT_IMPLEMENTED
.
Create a mobile user.
Type: pseudo-synchronous or asynchronous (depending on timeout parameter)
History of change: | DLS version | Change |
---|---|---|
.HI-DLS.10.202.00. | created |
sessionRef
- a valid session reference obtained through
openSession(java.lang.String, java.lang.String)
orderID
- transparent to DLS (used by client to separate different users -
if the client application uses the same session for all of
them)e164User
- The mobile users e164 number.e164UserPin
- userDataProfile
- User data rofile to use when creating the mobile user.ppData
- If set to 'true' use plug & play data when creating mobile user.
This requieres plug & play data to be configured prior to adding the mobile user.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |