Skip to main content

Get Injury Data

Support avatar
Written by Support
Updated over 9 months ago

GET [ incident/get-injury-data/{incidentId?} ]

Production Endpoint: https://app.complyflow.com.au/app/public/index.php/api/incident/get-injury-data/{incidentId?} 
Test Endpoint: https://test.complyflow.com.au/app/public/index.php/api/incident/get-injury-data/{incidentId?}

When IncidentId not specified on the URL then will return injury data from all incident. Otherwise will return injury data from specific incident

Overview

This API is only available to customers using the Incident Module Injury Table feature (an Advanced Setting that captures extended Safe Work Data, including TOOCS information (available to POST to Solv Claims Management Software).
​
This endpoint fetches injury data from all or a specific incident.


Authentication instructions

Refer to the Authentication method for Authentication Methods (for Login and Logout).
​

Permissions Required

The user will require the permissions below:

  • API User

  • User is Staff

  • Users have View Incident Permission

Please also refer to the Permissions Overview guide.

Query parameters

FIELD

TYPE

DESCRIPTION

Example

REQUIRED

DEFAULT

PATTERN

incidentId

integer

Incident ID

70

No

null

\d+

fromDate

date

Filter for Incidents after this date

20240403T02:00:00

No

null

YYYYMMDDThh:mm:ss

toDate

date

Filter for Incidents before this date

20240403T02:00:00

No

null

YYYYMMDDThh:mm:ss

Request Example

To return injury data from all incidents with filter fromDate and toDate parameter

curl --location 'http://test.complyflow.com.au/app/public/index.php/api/incident/get-injury-data?fromDate=20240402T12%3A00%3A00&toDate=20240410T12%3A00%3A00' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'

To return injury data from a specific incident:

curl --location 'http://test.complyflow.com.au/app/public/index.php/api/incident/get-injury-data/327' \
--header 'Authorization: [...]' \
--header 'Cookie: [...]'

Response Example

The API Request returns injury data from all or specific incidents based on the incidentId parameter provided or not.

{
"token": "[...]",
"data": {
"327": {
"dateEmployerNotified": "09-04-2024",
"incidentShiftTime": "Between 75% and the end of scheduled shift",
"injury": [
{
"id": 2,
"type": "Employee",
"employmentType": "Permanent Full Time",
"occupation": "",
"staffId": "S727",
"staffAttributes": [],
"descriptionOfInjury": "digigit nyamuk",
"injuryOutcome": "First Aid",
"injuryOutcomeCode": "FAI",
"treatment": "",
"docterConsulted": false,
"aggravation": false,
"nature": {
"category": "WOUNDS, LACERATIONS, AMPUTATIONS AND INTERNAL ORGAN DAMAGE",
"description": "Superficial injury",
"code": "159"
},
"bodilyLocation": {
"category1": "LOWER LIMBS",
"category2": "UPPER LEG",
"description": "Upper leg",
"code": "520"
},
"mechanism": {
"mechanismOf": "Chemicals and other substances",
"description": "Long term contact with chemicals or substances",
"code": "62"
},
"agency": {
"1digitDesc": "Materials and substances",
"2digitDesc": "Other materials and objects",
"3digitDesc": "Glass",
"description": "Molten glass",
"code": "6262"
},
"firstName": "Ano",
"lastName": "Nymus",
"dob": "09/04/2024",
"gender": null,
"address": null,
"suburb": null,
"postcode": null,
"state": null,
"email": "cfdemo-alan-ano@complyflow.com",
"sentToSolv": false,
"sentToSolvAt": null
}
]
}
}
}

Did this answer your question?