ProcFormLayoutShare

ProcFormLayoutShare(
	int FormID,
	int LayoutID
)

Generates a saved document and returns the quick share link for them.

Request

Request Data:

  • (int) FormID (required) – the form to save as a document using one of the existing layouts
  • (int) LayoutID (optional) – the ID of the layout to use
{
    "FormID": <int>,
    "LayoutID": <int>
}

Response

{
    "Result": {
        "FormID": <int>,
        "LayoutID": <int>,
        "LayoutDocumentID": <string:guid>,
        "DocumentUrl": <string>,
        "DocumentUrlForGuest": <string>
    }
}

Notes:

  • The LayoutDocumentID is a GUID for the saved layout
  • DocumentUrl will be empty if quick share is not enabled for staff users
  • DocumentUrlForGuest will be empty if quick share is not enabled for guest users

Errors

  • “Form not found”
  • “Layout not found”
  • “Permission denied” – if the user does not have permission to see the form
  • “Quick share is not enabled”