Api/ProcFormNoteAdd

From RPM Wiki

Table of contents
1 Summary
2 Request

2.1 Examples

3 Response
4 Errors
5 Details
6 History
[edit]

Summary

API: Add a note to a form

[edit]

Request

You need to identify the form and the note text

  • Either the form ID or form number + process is needed.
  • The note text is specified per note type, and both types of notes can be added at once.

Form by form ID, note for all and for staff 

{
  "Key":"{api key}",
  "Form": {
    "FormID":"{form id}",
    "Note":"{note text}",
    "NoteForStaff":"{note text}"
  }
}

By form number + process name, note just for staff 

{
  "Key":"{api key}",
  "Process":"{process name}",
  "Form": {
    "Number":"{form number}"
     "NoteForStaff":"{note text}"
  }
}
[edit]

Examples

http://demo.rpmsoftware.com/rpm/Api.svc/ProcFormNoteAdd 

{
  "Key":"abc123def456",
  "ProcessID":"12",
  "Form": {
    "Number":"Q123456",
    "Note":"This note will be added into the Notes box",
    "NoteForStaff":"This note will be for staff only"
  }
}
[edit]

Response

Use the response from Api/ProcForm

[edit]

Errors

  • "Process not found"
  • "Form not found"
  • "Permission denied" (the API user does not have permission to add notes to that form)
[edit]

Details

[edit]

History

Retrieved from "http://rpmsoftware.com/wiki/index.php/Api/ProcFormNoteAdd"
  • This page was last modified 06:50, 23 Mar 2010.
  • This page has been accessed 109 times.