ProcFormParticipantAdd

ProcFormNoteAdd(
    int    ProcessID,
    string ProcessName,
    string Username,
    string Agency,
    int    AgencyID,
    object Form
)

Add a Participant to the 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.

Identifying the New Participant:
You can identify the Participant by username or RPM can use the first staff user of an Agency:

  • Username provide the staff user by its username.
  • Agency Name or ID provide the Name or ID of an Agency, RPM will select the first user in that Agency (starting with managers).

Request Data:

  • (int) ProcessID or (string) ProcessName (optional) identify the process by Name or ID
    If both are provided the Name will be used.
  • (string) Username (optional) identify the user by its username.
  • (int) AgencyID or (string) Agency (optional) identify the process by ID or Name
    If both are provided the Name will be used.
  • (object) Form (required) – data to identify the form to be modified:
    • (string) FormID (optional, required if ProcessID or ProcessName are not provided) – unique ID number for this form.
      Used to identify the correct Form to add the Participant.
      If provided, then ProcessID, ProcessName and Form.Number will be ignored.
    • (string) Number (optional, required if ProcessID or ProcessName are provided) – unique number for this form.
      Used to identify the correct Form to add the Participant.

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

Form ID

{
  "Username": <string>,
  "Form": {
    "FormID": <int>,
  }
}

IndentifyProcess (Name or ID) + Form Number

{
  "Username": <string>,
  "ProcessID": <int>,
  "Process":<string>,
  "Form": {
    "Number": <string>,
  }
}

Identify User by Agency

{
  "Agency": <string>,
  "AgencyID": <int>,
  "Form": {
    "FormID": <int>,
  }
}

Response

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

Errors

  • “User not found” – if the provided username is not found.
  • “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
  • “Agency not found” – If the agency can’t be identified through Agency or AgencyID
<span>%d</span> bloggers like this: