Worker Incident Status Resource¶

Get Work Incident Status¶

HTTP Request

GET /api/workerIncidentStatuses/{id}

📋 Description: Retrieves the status details of a specific worker incident by its unique identifier, providing essential insights for incident management and reporting.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkerIncidentStatusDTO

Example Responses

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "isDefault": true,
  "objectAvailable": true,
  "workerIncidentStatusType": "string",
  "isDefaultType": true
}

Update Worker Incident Status¶

HTTP Request

PUT /api/workerIncidentStatuses/{id}

📋 Description: Updates the status of a specific worker incident identified by the provided ID, enabling organizations to maintain accurate records and streamline incident management processes.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	WorkerIncidentStatusDTO	true	Request body containing the updated incident status data for the specified worker, including relevant attributes and metadata.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "isDefault": true,
  "objectAvailable": true,
  "workerIncidentStatusType": "string",
  "isDefaultType": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

1{}

Response Schema

Delete Worker Incident Status¶

HTTP Request

DELETE /api/workerIncidentStatuses/{id}

📋 Description: Deletes a specific worker incident status identified by the provided ID, facilitating the management and maintenance of incident records within the system.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
204	No Content	No Content	None

Get All Worker Incident Statuses¶

HTTP Request

GET /api/workerIncidentStatuses

📋 Description: Retrieves the current statuses of worker incidents, providing an overview of incident management for effective workforce oversight.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  {
    "id": 0,
    "createdBy": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "displayId": "string",
    "name": "string",
    "isDefault": true,
    "objectAvailable": true,
    "workerIncidentStatusType": "string",
    "isDefaultType": true
  }
]

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[WorkerIncidentStatusDTO]	false	none	[Data transfer object representing the status of worker incidents, including relevant metadata to facilitate tracking and management of workplace safety and compliance.]
» id	integer(int64)	false	none	Unique identifier for the resource
» createdBy	string	false	none	Username of who created this resource
» createdAt	string(date-time)	false	none	Timestamp when this resource was created
» displayId	string	false	none	Unique identifier for the display
» name	string	true	none	Name of the resource
» isDefault	boolean	false	none	Whether the resource is default
» objectAvailable	boolean	false	none	Indicates whether the worker is available for incident response, facilitating effective resource allocation and management.
» workerIncidentStatusType	string	false	none	Type of the worker incident status
» isDefaultType	boolean	false	none	Whether the resource is default

Create Worker Incident Status¶

HTTP Request

POST /api/workerIncidentStatuses

📋 Description: Creates a new worker incident status record, enabling organizations to effectively track and manage the status of incidents involving their workforce.

Parameters

Name	In	Type	Required	Description
body	body	WorkerIncidentStatusDTO	true	Request body containing the details of worker incident statuses, including relevant identifiers and status updates for effective incident management.

Body Parameters

{
  "id": 0,
  "createdBy": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "displayId": "string",
  "name": "string",
  "isDefault": true,
  "objectAvailable": true,
  "workerIncidentStatusType": "string",
  "isDefaultType": true
}

Responses

Status	Meaning	Description	Schema
201	Created	Created	Inline

Example Responses

1{}

Response Schema

Get All Worker Incident Status Type¶

HTTP Request

GET /api/workerIncidentStatuses/workerIncidentStatusType

📋 Description: Fetches the available worker incident status types, providing essential information for managing and categorizing worker incidents effectively.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "OPEN"
]