RPC Services

Get form URL for user

Description

This endpoint returns a URL that may be used one time to access a form or flow, authenticated as the specified user. While authenticated as an administrator, this can be for any user on the domain. For other users, it can only function when used to produce a URL bound to their own user account.

Request

POST /liveflows/api/getFormLinkForUser

Parameter	Description
domain	The name of a valid domain which the authenticated user has access to.
appId	The id of an application in the domain.
formId	The request must include one of either formId or flowId. The id of the requested form.
flowId	The request must include one of either formId or flowId. The id of the requested flow.
user	The name of the user that the URL should be produced for.

Example JSON request

{
   "domain": "demo",
   "appId": "1"
   "formId": "1",
   "user": "user1",
}

Example XML request

<?xml version="1.0" encoding="UTF-8"?>
<request>
    <domain>demo</domain>
    <appId>1</appId>
    <formId>1</formId>
    <user>user1</user>
</request>

Response

Possible HTTP response codes:

Code	Description
200 OK	Success
400 BAD REQUEST	The specified domain, application, form, flow, or user may not exist.
401 UNAUTHORIZED	The username/password used for authentication was invalid.
403 FORBIDDEN	The authenticated user does not have permission to generate a URL for the specified user.
500 SERVER ERROR	The request failed due to an internal server error.

If the request is successful, a JSON (default) or XML payload will be returned containing the requested information.

Example JSON response

{
   "formLinkForUser": "/liveforms/path/of/form/url?token=abc123",
   "link": [{
      "rel": "formLinkForUser",
      "href": "/liveforms/path/of/form/url?token=abc123"
   }]
}

Example XML response

<?xml version="1.0" encoding="UTF-8"?>
<response>
   <formLinkForUser>/liveforms/path/of/form/url?token=abc123</formLinkForUser>
   <link rel="self" href="/liveforms/path/of/form/url?token=abc123"/>
</response>