DesignerStartSessionV3
The DesignerStartSessionV3 call starts a KCM Designer session. It returns a relative URL that provides access to KCM Designer.
The request requires the following fields next to the standard fields.
| Field | Type | Description |
|
user |
message |
Optional. If a user name is passed, the user is logged in automatically, and the returned URL leads to the
Dashboard of
KCM Designer.
When the LDAP mode is enabled in KCM Designer, you cannot use this field. For more information on LDAP, see the Kofax Communications Manager Installation Guide. |
The response contains the following fields in addition to the standard fields.
| Field | Type | Description |
|
ccmsessionid |
sessionId |
KCM Contract Manager session identifier. |
|
url |
url |
A URL that is relative to the base URL of Kofax Communications Manager. Example: https://<kcm server>:443/ccm/ All relative URLs that are returned are relative to this base URL. |
In case of an error, the response contains a SOAP Fault structure.
The DesignerStartSessionV3 call belongs to the CCMAdministration contract type and can only be used when application authentication is enabled on the Contract Manager.