This API allows clients to read and write training 'Records' and should be used in association with the Training Packages API.
Throughout the API an 'api_id' is used. This can be specified by the client when creating a new Record via the API, if one is not specified during creation or it is created via a different method (i.e. the user interface) then the API ID can be obtained by querying the API.
Users can be created and managed using the Directory API: Users endpoints and will be referenced in this set of APIs.
A Training Package is the definition of a training module. A Package may have zero, one or more Records associated.
A Training Record is a a record of an assigned or completed training Package assigned to an employee. It holds the state of the training for that employee.
GET /training/record/
List all Training Records in this organisation.
Parameters
| search: string | A search term (you can search by 'name') |
| limit: integer | Number of results to return per page |
| offset: integer |
The initial index from which to return results |
Response
Returns an object including a list of Records.
{
[
{
api_id: string,
person_api_id: string,
package_api_id: string,
package_desc: string,
date_assigned: datetime,
date_started: datetime,
date_completed: datetime
}
]
}
POST /training/record/
Create a new Training Record.
Parameters
None
Request Body
{
api_id: string,
person_api_id: string,
package_api_id: string,
date_started: datetime,
date_completed: datetime
}
Response
Returns an object including the created Record.
{
api_id: string,
person_api_id: string,
package_api_id: string,
package_desc: string, # Populated from package for ease of access
date_assigned: datetime, # Auto generated from time record was created
date_started: datetime,
date_completed: datetime
}
GET /training/record/{ api_id }/
Get a single Training Record.
Parameters
None
Response
Returns an object for this specific Training Record.
{
api_id: string,
person_api_id: string,
package_api_id: string,
package_desc: string, # Populated from package for ease of access
date_assigned: datetime, # Auto generated from time record was created
date_started: datetime,
date_completed: datetime
}
PUT:PATCH /training/record/{ api_id }/
Update or partially update the details of a Record.
Parameters
None
Request Body
{
api_id: string,
person_api_id: string,
package_api_id: string,
date_started: datetime,
date_completed: datetime
}
Response
Returns an object for this specific Training Record.
{
api_id: string,
person_api_id: string,
package_api_id: string,
package_desc: string, # Populated from package for ease of access
date_assigned: datetime, # Auto generated from time record was created
date_started: datetime,
date_completed: datetime
}
DELETE /training/record/{ api_id }/
Delete a Training Record..
Parameters
None
Request
None
Response
None