GET /api/v1/paths/sessions/{pathSessionId}/classrooms/{classroomId}/usersNeedingRegistration

Available on October 30th, 2023.

This route returns the array of user ids registered to the path session but not registered to any classroom slot of that session.

Errors

Status codeError bodyReason
401{ "error": "{{usual_route_authentication_errors}}" }Bad authentication (missing/unmatching/unexisting authentication)
404{ "error": "path_session_not_found" }Path Session does not exist in the specified company
404{ "error": "classroom_not_in_path" }The classroom ID specified does not correspond to any block of the session

Changelog

Servers

Path parameters

Name Type Required Description
pathSessionId String Yes

ID of the path session

classroomId String Yes

ID of the classroom

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.