ProcForm

ProcForm(
    int    processID,
    string Process,
    int    FormNumber,
    int    FormID
)

Get a Form.

Request

Identifying the Form:
You can identify the Form to in three different ways:

  • Form ID provide the Form ID inside the Form object.
  • Process Name + Form Number provide the process name and identify the form number inside the Form object.
  • Process ID + Form Number provide the process id and identify the form number inside the Form object.

Request Data:
The form data to be populated is formatted the same way as ProcFormAdd.

  • (int) ProcessID or (string) Process (optional) identify the process by Name or ID
    If both are provided the Name will be used.

  • (string) FormNumber (optional, required if ProcessID or Process are provided) – unique number for this form.
    Used to identify the correct Form to get.

  • (string) FormID (optional, required if ProcessID or Process are not provided) – unique ID number for this form.
    Used to identify the correct Form to get.
    If provided, then ProcessID, Process and FormNumber will be ignored.

Request Body:

{
    "Process": <string>,
    "ProcessID": <string>,
    "FormNumber": <string>,
    "FormID": <string>
}

Response

On success, the response will contain the referenced Form, see the JSON Formatting for Forms.

Errors

  • “Process not found” – If process Name or ID is not found
  • “Form not found”
%d bloggers like this: