Incidents

This page documents the API endpoints for retrieving incident data programmatically. If you need to view, edit, or report on an individual incident record in vCore, for example when preparing evidence for the NDIS Commission, see Editing incidents and the SIRS register instead.

GET /incidents

Example: GET /incidents?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100 Query parameters:

Parameter	Default	Description
`limit`	200	Maximum rows returned. There is no `page` parameter on this endpoint, so use date windows to retrieve more than `limit` rows
`fromDate`	-	Incidents with NoteDate >= value. Format: `YYYY-MM-DD`
`toDate`	-	Incidents with NoteDate <= value. Format: `YYYY-MM-DD`
`createDateFrom`	-	Incidents with Timestamp >= value. Format: `YYYY-MM-DD`
`createDateTo`	-	Incidents with Timestamp <= value. Format: `YYYY-MM-DD`
`clientId`	-	Filter by client ID (compares against `_ReferringId_1`)
`assignedTo`	-	Filter by assigned user email
`closed`	-	Filter by closed status: `1` or `0`. The values `true`/`false` are not recognised and behave as `0`
`taskClosed`	-	Filter by task closed status: `1` or `0`. The values `true`/`false` are not recognised and behave as `0`
`inclForm`	-	If `TRUE`, adds a `Form` object to each incident. Parameter names are case-sensitive: `InclForm` is ignored

Response fields:

Field	Type	Notes
`IncidentId`	integer
`CategoryId`	integer
`IncidentType`	string	for example `"CLIENT"`
`Note`	string
`Reason`	string
`Comment`	string
`Action`	string
`Outcome`	string
`Response`	null/string
`Location`	string
`Occurrence`	string
`Performance`	string
`NoteDate`	string	Datetime
`NotifiedDate`	string	Datetime
`AlertDate`	string	Datetime
`CloseDate`	string	Datetime
`TaskClosedDate`	string	Datetime
`IsReportable`	integer	0/1
`Reported24Hour`	integer	0/1
`Reported5Day`	integer	0/1
`AssignedTo`	string	Email
`AssignedToSecond`	string
`Closed`	integer	0/1
`TaskClosed`	integer	0/1
`RequiresFollowUp`	integer	0/1
`VisibleClientApp`	integer	0/1
`VisibleWorkerApp`	integer	0/1
`CreatedBy`	string	User display name
`DataSource`	string	for example `"Incidents"`
`Priority`	string
`ReadDate`	string	Datetime
`ReadBy`	string
`IncidentCode`	string
`Timestamp`	string	Datetime
`_ReferringId_1`	integer	Usually the client ID. For roster-linked incidents this can hold the roster item ID, with the client in `_ReferringId_2` and worker in `_ReferringId_3`
`_ReferringId_2`	integer
`_ReferringId_3`	integer

Form (when inclForm=TRUE): an object with the same fields as a /Forms row plus Signature, SignatureDate and VehicleId. Form.FormData is null when there is no submission, otherwise an object whose answers value is an object keyed by question ID, each with name, text, type, order and optionally answer.

GET /SIRS

Serious Incident Response Scheme incidents. Example: GET /SIRS?fromDate=YYYY-MM-DD&toDate=YYYY-MM-DD&limit=100 Query parameters:

Parameter	Default	Description
`limit`	200	Maximum rows returned. There is no `page` parameter on this endpoint
`fromDate`	-	SIRS with IncidentDate >= value. Format: `YYYY-MM-DD`. Records with no incident date are only returned when no date filter is set
`toDate`	-	SIRS with IncidentDate <= value. Format: `YYYY-MM-DD`
`createDateFrom`	-	SIRS with Timestamp >= value. Format: `YYYY-MM-DD`
`createDateTo`	-	SIRS with Timestamp <= value. Format: `YYYY-MM-DD`
`clientId`	-	Filter by client ID (maps to `_ReferringId_1`)
`assignedTo`	-	Filter by assigned user email
`closed`	-	Filter by closed status: `1` or `0`. The values `true`/`false` are not recognised and behave as `0`
`taskClosed`	-	Filter by task closed status: `1` or `0`. The values `true`/`false` are not recognised and behave as `0`

Response fields:

Field	Type	Notes
`SIRSIncidentId`	integer
`CategoryId`	integer
`Note`	string
`Reason`	string
`Comment`	string
`Action`	string
`Outcome`	string
`Response`	array	Objects of `{ Question, Answer, Outcome }`. `Answer` is `"yes"`, `"no"` or `null`
`Priority`	string
`IncidentDate`	string	Datetime. `0000-00-00 00:00:00` when not set
`NotifiedDate`	string	Datetime
`AlertDate`	string	Datetime
`CloseDate`	string	Datetime
`TaskClosedDate`	string	Datetime
`AssignedTo`	string
`AssignedToSecond`	string
`Closed`	integer	0/1
`TaskClosed`	integer	0/1
`RequiresFollowUp`	integer	0/1
`VisibleClientApp`	integer	0/1
`VisibleWorkerApp`	integer	0/1
`IsReportable`	integer	0/1
`Reported24Hour`	integer	0/1
`Reported5Day`	integer	0/1
`ReadDate`	string	Datetime
`ReadBy`	string
`CreatedBy`	string	Email
`Timestamp`	string	Datetime
`_ReferringId_1`	integer	Client ID
`_ReferringId_2`	integer
`_ReferringId_3`	integer

Overview

Clients

Workers

Categories

Organisation

Scheduling

People

Records

Incidents

GET /incidents

GET /SIRS

​GET /incidents

​GET /SIRS

GET /incidents

GET /SIRS