ProcFormNoteAdd

ProcFormNoteAdd(
    int    processID,
    string processName,
    object Form
)

Add Notes, including Notes For Staff, to a Form.

Request

Identifying the Form:
You can identify the Form to Edit 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:

  • (int) ProcessID or (string) ProcessName (optional) identify the process by Name or ID
    If both are provided the Name will be used.
  • (object) Form (required) – data that you want populated:
    • (string) Number (optional, required if ProcessID or ProcessName are provided) – unique number for this form.
      Used to identify the correct Form to Edit.
    • (string) FormID (optional, required if ProcessID or ProcessName are not provided) – unique ID number for this form.
      Used to identify the correct Form to Edit.
      If provided, then ProcessID, ProcessName and Form.Number will be ignored.
    • (string) Note (optional) note to add.
    • (string) NoteForStaff (optional) note for staff to add.
    • (string) NoteBy (optional) username of the user to get authorship of the note (by default, the note author is the user associated to the API key).

Request Body: these show the three different ways the Form can be identified.

Form ID

{
  "Key": <string>,
  "Form": {
    "FormID": <int>,
    "Note": <string>,
    "NoteForStaff": <string>,
    "NoteBy": <string>
  }
}

Process Name + Form Number

{
  "Key": <string>,
  "Process": <string>,
  "Form": {
    "Number": <string>,
    "Note": <string>,
    "NoteForStaff": <string>,
    "NoteBy": <string>
  }
}

Process ID + Form Number

{
  "Key": <string>,
  "ProcessID": <int>,
  "Form": {
    "Note": <string>,
    "NoteForStaff": <string>,
    "Number": <string>,
    "NoteBy": <string>
  },
}

Response

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

Errors

  • “Process not found” – If the process Name or ID is not found
  • “Form not found” – If the form could not be identified through Process + Form.Number or FormID
<span>%d</span> bloggers like this: