Api/ProcActionsDue

From RPM Wiki

Table of contents
1 Summary
2 Request

2.1 Example

3 Response

3.1 Example

4 Errors
[edit]

Summary

API: Get action due counts for every staff user by process, just like the actions due report.

[edit]

Request

No extra data needed. 

{
  "Key":"{api key}"
}
[edit]

Example

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

{
  "Key":"abc123def456"
}
[edit]

Response 

{"ProcActionsDueResult":
  {
    "Procs": [
      {
        "Staff": "{staff user name}",
        "StaffID": {staff user id},
        "Due": [
          {
            "Process": "{process name}",
            "ProcessID": {process id},
            "ActionsDueNormal": {count},
            "ActionsDueHigh": {count},
            "ActionsDue": {count},
          },
          {repeat as needed}
        ]
      },
      {repeat as needed}
    ]
  }    
}
  • Only list staff with at least one action due
  • Only list processes per staff that have at least one action due
[edit]

Example 

{"ProcActionsDueResult": [
  {
    "Procs": [
      {
        "Staff": "John Smith",
        "StaffID": 402,
        "Due": [
          {
            "Process": "Order",
            "ProcessID": 12,
            "ActionsDueNormal": 9,
            "ActionsDueHigh": 35,
            "ActionsDue": 44
          },
          {
            "Process": "Quote",
            "ProcessID": 9,
            "ActionsDueNormal": 5,
            "ActionsDueHigh": 9,
            "ActionsDue": 14
          }
        ]
      },
      {
        "Staff": "Mary Anderson",
        "StaffID": 104,
        "Due": [
          {
            "Process": "Order",
            "ProcessID": 12,
            "ActionsDueNormal": 2,
            "ActionsDueHigh": 7,
            "ActionsDue": 9
          }
        ]
      }
    ]
  }
}
[edit]

Errors

  • "No actions due"
Retrieved from "http://www.rpmsoftware.com/wiki/index.php/Api/ProcActionsDue"
  • This page was last modified 20:32, 16 Nov 2010.
  • This page has been accessed 1446 times.