Job Profiles

Provides access to job profiles

API URIDescription
jobprofiles

Retrieve a list of job profiles for the organization

Certificates

Provides access to training certificates

API URIDescription
employees/{id}/certificates

Retrieve a list of certificates by employee id

employees/{employeeId}/certificates

Adds a certificate for an employee

employees/{employeeId}/certificates/{id}

Updates a certificate

employees/{employeeId}/certificates/{id}

Deletes A certificate

employees/{employeeId}/certificates/{id}/attachment

Upload An attachment for a certificate For this endpoint you must attach a multipart content containing the file to the request

employees/{employeeId}/certificates/{id}/attachment

Download An attachment for a certificate

employees/{employeeId}/certificates/{id}/attachment

Delete the attachment of a certificate

EmployeeHours

Provides access to Employee Hours for any year beyond 2013 (2014+ inclusive).

API URIDescription
employeehours/{year}

Get year worth of Employee Hours records for your organization or a single site by adding filter ?siteId={siteId}

employeehours

Adding or Updating existing Employee Hours records

Diagnostic / Status

Provides access to diagnostic and testing information

API URIDescription
status

Checks the current status of the eCMS API.

Permission Groups

Provides access to permission groups

API URIDescription
permissiongroups

Retrieve a list of permission names available

Employees

Provides access to employees

API URIDescription
employees

Retrieve a list of employees by filtering on a limited set of URI parameters.

employees/{id}

Retrieve an employee by ID

employees

Updates all information in one employee profile. This endpoint replaces all information on the record, so fields which are not specified will be cleared. First name, last name and email cannot be modified for employee profiles which correspond to users who can log in to the system.

employees

Adds a single employee.

employees/import

Imports a list of employees.

employees/ImportExcelFile

Import employees from an excel file.

employees/{id}/terminate/{terminationDate}

Terminate an employee by ID on a specific date, or the current date if no date is provided

employees/ProfileInfo/{id}

Retrieve basic employee information. Although similar to employees/{id} it's recommended to use employees/{id}

Training

Provides access to training

API URIDescription
Training/GetTrainingFor/{id}

Retrieve training for an employee. Training is represented as a card. A card represents a course. If the employee has a certificate for a course it will be on the card. If the training is required it will be indicated on the card.

Site Memberships

Provides access to site memberships

API URIDescription
SiteMemberships/GetMembershipsFor/{id}

Retrieves site memberships for an employee.

Site Memberships

API URIDescription
SiteMemberships/GetMembershipsFor/{id}

Retrieves site memberships for an employee.

Assets

Provides access to asset

API URIDescription
assets

Retrieve a list of assets for the organization

assets/{id}

Retrieve an asset by id

assets/{id}/DownloadFile/{fileId}

Retrieve an attachment for an asset

Meetings

Provides access to meetings

API URIDescription
meetings/{id}

Retrieve a meeting by ID

meetings

Retrieve a list of meetings by filtering on a limited set of URI parameters.

meetings/{id}/pdf

Retrieve a PDF of the requested meeting, by ID

meetings/{id}/DownloadFile/{fileId}

Retrieve an attachment for a meeting, by ID

Sites

Provides access to site information

API URIDescription
sites

Retrieves a list of all sites the requester has access to

Hazard Assessments

Provides access to Hazard Assessments

API URIDescription
hazardassessments/{id}

Retrieve a Hazard Assessment by ID

Training Requirements

Provides access to training requirements

API URIDescription
employees/{id}/trainingrequirements

Retrieve a list of training requirements by employee id

employees/{id}/TrainingRequirements/{trainingRequirementId}

Delete the trainingRequirement of the employee

employees/{id}/trainingrequirements

Update a training requirement

Incidents

Provides access to incident forms

API URIDescription
incidents/{id}

Retrieves an incident by ID

incidents

Retrieves a list of incidents by filtering on a limited set of URI parameters

incidents/{id}/pdf

Retrieves a PDF of the requested incident, by ID

incidents/{id}/DownloadFile/{fileId}

Retrieves an attachment for an incident, by ID

Inspections

Provides access to inspections

API URIDescription
inspections/{id}

Retrieve an inspection by ID

inspections

Retrieve a list of inspections by filtering on a limited set of URI parameters

inspections/{id}/pdf

Retrieve a PDF of the requested inspection, by ID

inspections/{id}/DownloadFile/{fileId}

Retrieve an attachment for an inspection, by ID

AttachmentsV1

Provides access to documents

API URIDescription
Attachments/Upload

Upload an attachment to the current site.

Attachments/Download

Download a document by it's id Attachments/Download?documentId={id}

Asset Group

Provides access to asset groups

API URIDescription
assetgroups

Retrieve a list of asset groups for the organization

assetgroups/{id}

Retrieve an asset group by id

assetgroups/{id}/assettypes

Retrieve a list of asset types for the organization by group id

Courses

Provides access to courses

API URIDescription
courses

Get a list of courses

Asset Types

Provides access to asset types

API URIDescription
assettypes

Retrieve a list of asset types for the organization

assettypes/{id}

Retrieve an asset type by id

assettypes/{id}/DownloadFile/{fileId}

Retrieve an attachment for an asset type

assettypes/summaries

Retrieve a list of asset types summaries for the organization

Action Items

Provides accesss to action items and their attachments

API URIDescription
actionitems

Get a list of action items

actionitems/{id}/attachment/{attachmentId}

Retrieve an attachment for an action item