Training Package API

This API allows clients to read and write training 'Packages' to Perform & Engage 365.

Throughout the API an 'api_id' is used. This can be specified by the client when creating a new Package via the API, if one is not specified during creation or a Record is created via a different method (i.e. the user interface) then the API ID can be obtained by querying the API.

This API should be used in conjunction with the Training Record 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/package

List all Training Packages 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 Packages.

{
[
          {
            api_id: string,
            name: string,
            desc: string,
            training_format: string (in_person|online|both),
            objectives: string,
            more_info_link: string (in url format),
            link: string (in url format),
            is_live: boolean,
            is_deleted: boolean
           }
]
}

POST /training/package/

Create a new Training Package.

Parameters

None

Request Body

{
       api_id: string,
       name: string,
       desc: string,
       training_format: string (in_person|online|both),
       objectives: string,
       more_info_link: string (in url format),
       link: string (in url format),
       is_live: boolean,
       is_deleted: boolean
}

Response

Returns an object including the created Package.

{
    api_id: string,
    name: string,
    desc: string,
    training_format: string (in_person|online|both),
    objectives: string,
    more_info_link: string (in url format),
    link: string (in url format),
    is_live: boolean,
    is_deleted: boolean
}

GET /training/package/{ api_id }/

Get a single Training Package.

Parameters

None

Response

Returns an object for this specific Training Package.

{
    api_id: string,
    name: string,
    desc: string,
    training_format: string (in_person|online|both),
    objectives: string,
    more_info_link: string (in url format),
    link: string (in url format),
    is_live: boolean,
    is_deleted: boolean
}

PUT:PATCH /training/package/{ api_id }/

Update or partially update the details of a Package.

Parameters

None

Request Body

{
       api_id: string,
       name: string,
       desc: string,
       training_format: string (in_person|online|both),
       objectives: string,
       more_info_link: string (in url format),
       link: string (in url format),
       is_live: boolean,
       is_deleted: boolean
}

Response

Returns an object for this specific Training Package.

{
    api_id: string,
    name: string,
    desc: string,
    training_format: string (in_person|online|both),
    objectives: string,
    more_info_link: string (in url format),
    link: string (in url format),
    is_live: boolean,
    is_deleted: boolean
}

DELETE /training/package/{ api_id }/

Delete a Training Package from the organisation, this will also delete any associated Training Records.

Parameters

None

Request

None

Response

None