Table of Contents

• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Send Requests
• Conventions
• Authentication
• Status Codes
• Error Messages
• Collections
• Use cURL
• Using mongoDB Query Syntax

Tasks

• Certificate Type - Certificate
  • Get certificate type - certificate associations.
  • Get details of a certificate type - certificate association.
• Certificate Types
  • Get certificate types.
  • Get details of a certificate type.
• Certificates
  • Get certificates.
  • Get details of a certificate.
• Employee - Alerts
  • Get an employee alert.
  • Get employee alerts.
  • Get the status of the alert.
• Employee - Certificates
  • Download the image of an employee certificate scan.
  • Get details of an employee - certificate association.
  • Get employee - certificate associations.
• Employee - Checked State
  • Get associated work shift of an employee.
  • Get checked state of an employee.
• Employee - Device Provisionings
  • Get device provisioning.
  • Get device provisionings.
  • Get latest device provisioning.
• Employee - Logged-in Devices
  • Get devices that an employee is currently logged in.
  • Get logged-in device of an employee.
• Employee - Messages
  • Get a chat message.
  • Get incoming chat messages.
• Employee Wearable Type - Sensor Attribute - Devices
  • Get an employee sensor device association.
  • Get an employee sensor device association.
  • Get employee sensor device associations.
  • Get employee sensor device associations.
• Employee Wearable Type - Sensor Attributes
  • Get a specific sensor attribute within employee wearable type.
  • Get a specific sensor attribute within employee wearable type.
  • Get sensor attributes within employee wearable type.
  • Get sensor attributes within employee wearable type.
• Employee Wearable Types
  • Get a specific employee wearable type.
  • Get a specific employee wearable type.
  • Get employee wearable types.
  • Get employee wearable types.
• Employees
  • Get an employee.
  • Get available static roles.
  • Get current location(s) of an employee.
  • Get currently logged-in employee.
  • Get employees.
• Endpoints
  • Get details of an endpoint.
  • Get endpoints.
• Global configurations
  • Get details of a global configuration by key.
  • Get Global configurations.
• Incident - Comments
  • Get an incident comment.
  • Get incident comments.
• Incident - Occurrences
  • Get an incident occurrence.
  • Get incident occurrences.
• Incidents
  • Get an incident.
  • Get employees affected by the given incident.
  • Get incidents.
  • Get locations affected by the given incident.
  • Get projects affected by the given incident.
• Jobs
  • Get jobs.
  • Returns specific job.
• Location Type - Sensor Attributes
  • Get a specific sensor attribute within location type.
  • Get sensor attributes within location type.
• Location Types
  • Get a specific location type.
  • Get location types.
• Organization - Configurations
  • Get a specific configuration information of an organization.
  • Get organization configurations.
• Organizations
  • Get details of an organization.
  • Get organizations.
• Positionings
  • Get details of a positioning technology.
  • Get positioning technologies.
• Project - Asset Integration - Certificate Types
  • Get certificate type associated with the integration with Asset Monitoring Cloud Service.
  • Get certificate types associated with the integration with Asset Monitoring Cloud Service
• Project - Asset Integrations
  • Get details of an integration with Asset Monitoring Cloud Service.
  • Get integrations with Asset Monitoring Cloud Service.
  • Get locations created by the integration with Asset Monitoring Cloud Service.
• Project - Certificate Types
  • Get details of a project - certificate type association.
  • Get project - certificate type associations.
• Project - Configurations
  • Get a specific configuration of a project.
  • Get configurations of a project.
• Project - Hazard - Comments
  • Get a hazard comment.
  • Get comments for hazard.
• Project - Hazards
  • Get a hazard location.
  • Get hazard details.
  • Get hazard locations.
  • Get hazards.
  • Get the status of a hazard location.
  • Get the status of a hazard.
• Project - Location - Certificate Types
  • Get details of a location - certificate type association.
  • Get location - certificate type associations.
• Project - Location - Sensor Data Providers
  • Get location - location type - sensor data provider associations.
  • Get the specific location - location type - sensor data provider association.
• Project - Location Plans
  • Download an image of a location plan.
  • Get location plans.
  • Get the location plan defined in a project.
• Project - Locations
  • Get incidents for a specific location.
  • Get the children locations of a location.
  • Get the location details.
  • Get top level locations.
• Project - Positionings
  • Get details of project - positioning technology associations.
  • Get project - positioning technology associations.
• Project - Work Shifts
  • Get details of a project - work shift association.
  • Get work shifts associated with the project.
• Project Assignments
  • Get details about project assignment.
  • Get project assignments.
• Projects
  • Download the image of a project logo.
  • Get details of a project.
  • Get projects.
• Work Shifts
  • Get details of a work shift.
  • Get work shifts.