get_trainees

Gets a list of trainee assessors.

Parameters

Name Description Type Required
session_token Get from the get_session_token method string Yes
user_key API key for access string Yes
start_date     earliest date of trainee accession for filtering results
date Yes
end_date latest date of trainee accession for filtering results
date Yes


Response

Element Description
name representative name of the user
partner primary group membership of the user
 email email address of the user
id id of the user, for use with pass_trainee or fail_trainee
date the date of accession to trainee status
training_complete boolean indicating whether the user has completed training
training_result result of training completion - "pass", "fail", or nil (incomplete)

Errors

Text Meaning
API key is not authorized You need to submit a valid API key
 Schema Validation Failed  One of the XML elements is not valid (see subsequent message)
User $id is missing a required role
The user represented by the session token is not a training administrator.