Get Eligible Users

This synchronous Integration Point (IP) returns the list of users who are eligible to be assigned work items from a specified queue, together with each user’s current availability and workload.

Request

This API supports the following GET operation:

GET http://[hostName]:[portNumber]/[api-context-root]/queuedefinitions/{queueDefinitionCode}/eligibleusers

Details

An eligible user holds the Queue User or Queue Admin access role on the queue identified by queueCode.

Availability

  • For each eligible user, the IP returns an availability indicator that reflects the user’s current session state when the IP is called.

  • Permitted values are true and false.

Total Work Items In Current Queue

  • The count of work items assigned to the user from the queue identified by queueCode.

  • Work items in any status except Done are counted.

Total Work Items

  • The count of work items currently assigned to the user across all queues.

  • Work items in any status except Done are counted.

Response

The IP returns HTTP 200 (OK) on successful completion of the operation.

{
  "users": [
    {
      "userId": "1234",
      "displayName": "Bruce Harris",
      "availability": "true",
      "totalWorkItemsInCurrentQueue": 1,
      "totalWorkItems": 7
    },
    {
      "userId": "7890",
      "displayName": "Max Planck",
      "availability": "false",
      "totalWorkItemsInCurrentQueue": 0,
      "totalWorkItems": 2
    }
  ]
}
users

Array of eligible users who can be assigned work items from the queue. Each entry represents one user who holds the Queue User or Queue Admin access role on the queue.

userId

Unique identifier of the user.

displayName

Human-readable name of the user.

availability

Current login state of the user at the time the IP is called. True:: User is currently logged in to the system. False:: User is not currently logged in.

totalWorkItemsInCurrentQueue

Count of work items currently assigned to the user for the queue.

totalWorkItems

Total number of active work items currently assigned to this user across all queues.

ohi.worklist.useravailability.duration: "Duration in seconds that a queue user remains available after their most recently recorded activity.",

Authorization

This IP requires a grant for access restriction workitems.eligibleusers IP.

Response Messages

Failure

Response Severity Description

OHI-IP-WTSK-025

Fatal

Queue definition {queueDefinitionCode} is unknown.

The response can also contain generic error messages not specific to this web service. For more information, see Response Messages.