Displaying a list of relevant flows in an LMS will help users get a better overview, as more information is available directly from a single system. A list of relevant flows could be a list of participants on a flow, or a list of flows for a specific user.
This article uses the participant role as an example on how to show a list of flows, where a specific participant has been added. The same could be done with managers, assessors, or other WISEflow roles.
Use Case
POST /license/flows/search is used to search for flows using a set of predefined parameters. The below request will return flows where the participation period has started.
{
"metadata": {
"states": [
"PARTICIPATION_STARTED"
]
}
}Using the flowId from the response, GET /flows/{flowId}/participants is used to return participants on the given flow.
The response includes the userId, or any externalIds used to identify the user. An externalId will often be an organisation ID or another institution specific ID that can be used to directly link the WISEflow participant with a user.
The last step is to get a URL that can link directly to the flow in WISEflow. Having the userIds of the relevant users, GET /user/{userId}/flows is used to return a list of active flows for each userId. The URL from the response is a direct link to the flow. In the list displayed in the LMS, this URL can be renamed to the name of the flow, which is also found in the response. This way, flows can be presented in a list view. This list can be altered in many ways, for example to include if the participant has handed in.