Migrating from Stems One API v1.0

The intent of this Migration Guide document is to help existing businesses seamlessly port their integrations with Stems One API v1.0 to Stems One API v1.2.

Stems One API v1.2 introduces breaking changes on Hazard and Personnel sections.
This new version adds the ability to select multiple hazard types/subtypes. It also allow a hazard type with no associated subtypes to be selected.

1. Breaking Changes

Please check changes described below and update your integration accordingly.

Endpoint Breaking Change Version Introduced
GET /hazards The response data is changed to allow multiple types/subtypes data. The following Fields are removed:

  • typeId
  • typeName
  • subTypeId
  • subTypeName
  • typeString

The following field is added:

  • hazardTypes

 v1.2
GET /hazards/{id} Please refer to GET /hazards/ endpoint changes above. v1.2
POST /hazards The following Fields are removed:

  • typeId
  • subTypeId

The following field is added:

  • hazardTypes

 v1.2
PUT /hazards/{id} Please refer to POST /hazards/ endpoint changes above. v1.2
GET /hazards/types Subtypes are now optional in the data structure.
Please make to sure to handle Type data with no associated subtypes. 		v1.2
Get /personnel/{personnelId}/requiredtraining The response data was changed to match the update made in Stems One web application. Fields whose content was changed are: -

  • requiredBy
  • requiredByDesc

Fields whose name and content was changed are: -

  • courseId -> licenceCourseId
  • licenceId -> personnelLicenceCourseId

Newly added fields are: -

  • licenceCourseKey (LCK_Licence or LCK_Course)
  • requiredByType (RBT_OrgProfile, RBT_Role, or RBT_Custom)

 v1.2

2. New Endpoints

Here are endpoints newly added in this version of Stems One API.

Endpoint Description Version Introduced
Post /actions/event Add incident action v1.2
Get /actions/datasync/archived Retrieve archived action ids after previous data sync. v1.2.3
Get /actions/document/{id}/read Mark a document as read by login user v1.2.2
Post /actions/hazard Add hazard action v1.2
Get /actions/{id}/document/read Mark all documents in an action as read by login user v1.2.2
Get /actions/{id}/log/read Mark action logs in an action as read by login user v1.2.2
Get /events/datasync/archived Retrieve archived event ids after previous data sync. v1.2.3
Get /hazards/datasync/archived Retrieve archived hazard ids after previous data sync. v1.2.3
Get /injuryManagement/search Search injury management data v1.2.1
Get /Licence/{id}/downloadAttachedFile Download Licence record's attached file v1.2
Get /personnel/name Retrieve personnel id and name. This method is suitable to build dropdownlist v1.2
Get /personnel/{personnelId}/licence Retrieves Licence information of a specific Personnel Profile v1.2

3. Extended Endpoints

Here are endpoints which had new fields in their request/response data in this version.

Endpoint Description Version Introduced
Get /actions lastSyncedDateTime was added in request v1.2.3
Get /events/approvalData CreatedBy was added in request v1.2.2
Get /events/approvalData lastSyncedDateTime was added in request v1.2.3
Get /hazards lastSyncedDateTime was added in request v1.2.3
Get /personnel/{personnelId}/training bookedDate was added in response v1.2
Get /Users personnelId was added in response v1.2