Incidents

Gets a single incident case by ID.

Gets a single incident case by ID.

For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens

Securitybearer
Request
path Parameters
id
required
string <uuid>
Responses
200

Incident found

400

Bad Request. This typically means one or more request validation errors occurred. Check the response body for details. For more help troubleshooting, please see https://dev-developer.hcssapps.com/getting-started/troubleshoot-bad-request

get/v1/incidents/{id}
Request samples 
Response samples 
{
  • "EmployeeInjuries": [
    ],
  • "CreatedDateUtc": "2024-04-22T22:08:20.8892776Z",
  • "LastModifiedUtc": "2024-04-22T22:08:20.8892776Z",
  • "BusinessUnitDescription": "BU-123 description",
  • "ReportingStatus": "ReportedToThirdPartyCarrier",
  • "InsuranceCompanyName": "Allstate",
  • "InsuranceClaimTypes": [
    ],
  • "ClaimNumber": "111111",
  • "Adjuster": "FirstName LastName",
  • "AdjusterEmail": "adjuster@company.com",
  • "AdjusterPhone": "555-111-9999",
  • "AdjusterNotes": "adjuster notes",
  • "DateInvestigationBegan": "2024-04-23T22:08:20.8892776Z",
  • "Attachments": [],
  • "FieldAttachments": [],
  • "MinersInvolved": [
    ],
  • "ID": "d29ecec5-a4d6-4f2e-bac1-8fd0b57da337",
  • "CaseNumber": "injury-1234",
  • "Description": "Employee injured on-site",
  • "Notes": "Additional notes",
  • "FieldNotes": "Notes from Field Employees",
  • "JobCode": "construction-job-123",
  • "BusinessUnitCode": "BU-123",
  • "LocationDescription": "job site",
  • "ReportedDateUtc": "2024-04-22T22:08:20.8892776Z",
  • "RecorderCode": "employee-code-01",
  • "PersonInChargeCode": "employee-code-02",
  • "IncidentDateUtc": "2024-04-22T21:08:20.8892776Z",
  • "Status": "Reported",
  • "Address": {
    },
  • "Latitude": 29.76,
  • "Longitude": 95.37,
  • "Weather": "Overcast",
  • "PersonMostFamiliarCode": "employee-code-03",
  • "RecordedEmail": "employee01@company.com",
  • "RecordedPhoneNumber": "555-111-1111",
  • "PersonInChargeEmail": "employee02@company.com",
  • "PersonInChargePhoneNumber": "555-111-2222",
  • "PersonMostFamiliarEmail": "employee03@company.com",
  • "PersonMostFamiliarPhoneNumber": "555-111-3333",
  • "EstimatedCost": 1000,
  • "ActualCost": 1100,
  • "IsMSHAInvestigation": true,
  • "Individuals": "employee-code-01;employee-code-02;employee-code-03",
  • "SiteDescription": "Work site description",
  • "AccidentInjuryExplanation": "Employee injured left arm while working on XYZ",
  • "StepsToPreventFutureOccurrences": "Hazard control steps will be attached to equipment"
}
Updates an existing incident case by ID
Updates an existing incident by ID. If the incident does not already exist,
this call will return an error. 


For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
path Parameters
id
required
string <uuid> 
The incident ID.


 
Request Body schema: 
The incident you want to modify


ID
required
string <uuid> 
The HCSS unique identifier for the incident.


 
CaseNumber
string  [ 0 .. 100 ] characters 
The user-entered unique identifier for the incident. Must be unique within each company.


 
Description
required
string  [ 0 .. 2000 ] characters 
Description of the incident


 
Notes
required
string
Notes about this incident


 
FieldNotes
required
string
Field Notes about this incident


 
JobCode
required
string
The code for the job where the incident occurred


 
BusinessUnitCode
string
The code for the business unit associated with this incident. This value cannot be changed, edits to this value will trigger a 400 Bad Request response.


 
LocationDescription
required
string  [ 0 .. 2000 ] characters 
A description of the location where the incident occurred


 
ReportedDateUtc
required
string <date-time> 
The UTC date and time when the incident was reported


 
RecorderCode
required
string
The employee code of the person who recorded the incident


 
PersonInChargeCode
required
string
The employee code of the employee in charge when the incident occurred


 
IncidentDateUtc
required
string <date-time> 
The UTC date and time when the incident occurred


 
Status
string
Incident Status for this incident. 
Options: 'Open', 'Received', or 'Completed'.


 
object (ApiAddress) 
 
Latitude
number <double>   [ -90 .. 90 ] 
The incident location latitude


 
Longitude
number <double>   [ -180 .. 180 ] 
The incident location longitude


 
Weather
string  [ 0 .. 500 ] characters 
Weather conditions at the time of the incident


 
PersonMostFamiliarCode
string
The employee code for the person most familiar with the incident


 
RecordedEmail
string
Email of the person who recorded the incident


 
RecordedPhoneNumber
string
Phone Number of the person who recorded the incident


 
PersonInChargeEmail
string
Email of the person in charge when the incident occurred


 
PersonInChargePhoneNumber
string
Phone Number of the person in charge when the incident occurred


 
PersonMostFamiliarEmail
string
Email of the person most familiar with the incident


 
PersonMostFamiliarPhoneNumber
string
Phone Number of the person most familiar with the incident


 
EstimatedCost
number <double> 
Estimated cost of this incident


 
ActualCost
number <double> 
Actual cost of this incident


 
IsMSHAInvestigation
boolean
Did the incident required a MSHA Investigation


 
Individuals
string
Individuals list for MSHA Investigation. Separated by semi-colon (;)


 
SiteDescription
string
Site description


 
AccidentInjuryExplanation
string
Accident/Injury Explanation


 
StepsToPreventFutureOccurrences
string
Steps to Prevent Future Occurrences


 
Responses 
200
Incident saved successfully


400
Bad Request. This typically means one or more request validation errors occurred.
Check the response body for details.
For more help troubleshooting, please see https://dev-developer.hcssapps.com/getting-started/troubleshoot-bad-request


put/v1/incidents/{id}
Request samples 
{
  • "ID": "00000000-0000-0000-0000-000000000000",
  • "CaseNumber": "string",
  • "Description": "string",
  • "Notes": "string",
  • "FieldNotes": "string",
  • "JobCode": "string",
  • "BusinessUnitCode": "string",
  • "LocationDescription": "string",
  • "ReportedDateUtc": "2019-08-24T14:15:22Z",
  • "RecorderCode": "string",
  • "PersonInChargeCode": "string",
  • "IncidentDateUtc": "2019-08-24T14:15:22Z",
  • "Status": "string",
  • "Address": {
    },
  • "Latitude": -90,
  • "Longitude": -180,
  • "Weather": "string",
  • "PersonMostFamiliarCode": "string",
  • "RecordedEmail": "string",
  • "RecordedPhoneNumber": "string",
  • "PersonInChargeEmail": "string",
  • "PersonInChargePhoneNumber": "string",
  • "PersonMostFamiliarEmail": "string",
  • "PersonMostFamiliarPhoneNumber": "string",
  • "EstimatedCost": 0,
  • "ActualCost": 0,
  • "IsMSHAInvestigation": true,
  • "Individuals": "string",
  • "SiteDescription": "string",
  • "AccidentInjuryExplanation": "string",
  • "StepsToPreventFutureOccurrences": "string"
}
Response samples 
{
  • "EmployeeInjuries": [
    ],
  • "CreatedDateUtc": "2024-04-22T22:08:23.201832Z",
  • "LastModifiedUtc": "2024-04-22T22:08:23.201832Z",
  • "BusinessUnitDescription": "BU-123 description",
  • "ReportingStatus": "ReportedToThirdPartyCarrier",
  • "InsuranceCompanyName": "Allstate",
  • "InsuranceClaimTypes": [
    ],
  • "ClaimNumber": "111111",
  • "Adjuster": "FirstName LastName",
  • "AdjusterEmail": "adjuster@company.com",
  • "AdjusterPhone": "555-111-9999",
  • "AdjusterNotes": "adjuster notes",
  • "DateInvestigationBegan": "2024-04-23T22:08:23.201832Z",
  • "Attachments": [],
  • "FieldAttachments": [],
  • "MinersInvolved": [
    ],
  • "ID": "04b9c942-814a-4558-9bde-f65daeac3f2b",
  • "CaseNumber": "injury-1234",
  • "Description": "Employee injured on-site",
  • "Notes": "Additional notes",
  • "FieldNotes": "Notes from Field Employees",
  • "JobCode": "construction-job-123",
  • "BusinessUnitCode": "BU-123",
  • "LocationDescription": "job site",
  • "ReportedDateUtc": "2024-04-22T22:08:23.201832Z",
  • "RecorderCode": "employee-code-01",
  • "PersonInChargeCode": "employee-code-02",
  • "IncidentDateUtc": "2024-04-22T21:08:23.201832Z",
  • "Status": "Reported",
  • "Address": {
    },
  • "Latitude": 29.76,
  • "Longitude": 95.37,
  • "Weather": "Overcast",
  • "PersonMostFamiliarCode": "employee-code-03",
  • "RecordedEmail": "employee01@company.com",
  • "RecordedPhoneNumber": "555-111-1111",
  • "PersonInChargeEmail": "employee02@company.com",
  • "PersonInChargePhoneNumber": "555-111-2222",
  • "PersonMostFamiliarEmail": "employee03@company.com",
  • "PersonMostFamiliarPhoneNumber": "555-111-3333",
  • "EstimatedCost": 1000,
  • "ActualCost": 1100,
  • "IsMSHAInvestigation": true,
  • "Individuals": "employee-code-01;employee-code-02;employee-code-03",
  • "SiteDescription": "Work site description",
  • "AccidentInjuryExplanation": "Employee injured left arm while working on XYZ",
  • "StepsToPreventFutureOccurrences": "Hazard control steps will be attached to equipment"
}
Gets a list of incident cases.
Gets a list of incident cases.


A response header called "Pagination-MorePagesAvailable" will be sent in the response with a value of "yes" or "no", indicating whether more pages are available after
this one.  That is, if the header value is "yes", the client should request the next page.


For help with authorization, please visit https://developer.hcssapps.com/getting-started/request-tokens


Securitybearer 
Request 
query Parameters
modifiedAfterUtc
string <date-time> 
Limits the results to incidents that have been updated or created after the specified UTC time.


 
createdAfterUtc
string <date-time> 
Limits the results to incidents that have been created after the specified UTC time.


 
incidentDateAfterUtc
string <date-time> 
Limits the results to incidents that have an incident date after the specified UTC time.


 
incidentDateBeforeUtc
string <date-time> 
Limits the results to incidents that have an incident date before the specified UTC time.


 
limit
integer <int32> 
The number of results returned.  Default 1000.


 
offset
integer <int32> 
The page offset.  The response header "Pagination-MorePagesAvailable" indicates whether the call should be made again with an incremented offset.


 
Responses 
200
Incidents queried successfully


400
Bad Request. This typically means one or more request validation errors occurred.
Check the response body for details.
For more help troubleshooting, please see https://dev-developer.hcssapps.com/getting-started/troubleshoot-bad-request


get/v1/incidents
Request samples 
Response samples 
[
  • {
    }
]