Breadcrumbs Scheduling System > Interacting with the scheduling system > Candidate Management

Candidate Management

In Scheduler, candidates can be scheduled for tests or given access to the booking portal to book their own tests. Candidates are referred to as ‘students’ in Scheduler.

This article explains what calls can be made to the Scheduler API using the candidate management resource.

Import this API into your Postman Workspace

NOTE: This article documents the requests in the Candidate Management folder of the 'Scheduling System' Postman collection.
In This Article

Integration Flow

The following diagram shows the Candidate Management integration flow:

NOTE: Candidate (student) optimeIndex and enrolmentId can be stored in the CRM/Portal to remove additional requests to retrieve optimeIndex and enrolment identifiers.

Creating a candidate's user account first, by sending a POST request to the /users endpoint with userType set to Student, also creates a candidate (student) reference. Use the OptimeIndex identifier from the POST request response (from the userIndex property) to update the candidate in a PUT request to the /Students endpoint to assign the candidate (student) its details, such as forename and surname.

Candidates (Students)

Candidates can be scheduled for tests and are managed in the Data > Organisation > Candidates screen. The Students endpoint can be used to list, retrieve, create, update, and delete candidates.

Listing candidates

get /api/Students

Send a request to the endpoint to retrieve a list of candidates. Refer to the available parameters to influence the response. No request body is required.

Retrieving candidate information

get /api/Students/{studentId}

Send a request to the endpoint to retrieve information for a specific candidate using its ID. No request body is required.

Creating a candidate

post /api/Students

Send a request to the endpoint to create a candidate.

Updating a candidate

put /api/Students/{studentId}

Send a request to the endpoint to update a specific candidate.

Deleting a candidate

delete /api/Students/{studentId}

Send a request to the endpoint to delete a specific candidate. No request body is required.

Candidate user accounts (Users)

Candidates can also have their own user accounts, managed in the Data > User Management > Users screen, if they are given access to the booking portal to book their own tests. Candidate user accounts must be associated with corresponding candidate references (students).

The Users endpoint can be used to list, retrieve, create, and update candidate user accounts.

Listing candidate user accounts

get /api/Users/Dropdown

Send a request to the endpoint to retrieve a list of users. Refer to the available parameters to influence the response. No request body is required.

NOTE: Users can be either staff or candidate user accounts. To retrieve information specific to candidate user accounts, use the 'Retrieving candidate user account information' request.

Retrieving candidate user account information

get /api/Users/{userId}

Send a request to the endpoint to retrieve information for a specific candidate user account using their ID. No request body is required.

Creating a candidate user account

post /api/Users

Send a request to the endpoint to create a candidate user account.

Updating a candidate user account

put /api/Users/{userId}

Send a request to the endpoint to update a specific candidate user account.

Further reading

Read the following articles to learn more about the scheduling system or more about related APIs: