LaunchHTML method

Parameters

This method starts the specified HTML type application and if successful, returns the following:

	Important:
	The return values are described in Return values.

Parameter

Type

Description

applicationName

String

Name of the application to be launched. Contains zone information in the following format: ZoneId:appName.

Important:

The applicationName must match the name that was specified when the application was added to Avaya Experience Portal through the EPM.

For an application that is assigned to a non-default zone, include the zone information using the format: ZoneId:applicationName

You can view all application names on the Applications page.

You can retrieve the zone Id information using the getZoneInfo method of the Management Interface web service.

appParameters

String

Parameters to be sent to the launched application.

Contains name value using semicolon (;) as delimiter, in the following format: name=value;name=;. (Optional)

If a value contains a semicolon (“;”) it needs to be escaped using backslash (“\”).

ucid

String

Unique caller ID. (Optional)

parentID

String

Caller’s session ID. (Optional)

requestTimeout

Integer

Time to wait for the request to finish. (In seconds)

This value must be in the range 1-60 (inclusive).

Parameter	Type	Description
sessionID_htlpApp	String	If the request completed successfully, this return value contains the Experience Portal session ID that was created when the application was launched.
sessionID_AppServer	String	If the request completed successfully, this return value contains the Session ID that was created on the application server.
applicationURL	String	If the request completed successfully, this return value contains the application URI against which the HTML application was launched.