Jump to

• Request
• Response

Get employee alerts.

get

/connectedWorker/clientapi/v2/employees/{employeeId}/alerts

This operation retrieves alert for an employee.

Request

Path Parameters

• employeeId: string
  Employee identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Alerts were successfully retrieved.

Body ()

Root Schema : EmployeeAlerts

Type: object

Show Source

• items: array items
• links(optional): array links
  Read Only: true

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/EmployeeAlert"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object EmployeeAlert

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/EmployeeAlert"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : EmployeeAlert

Type: object

Show Source

• createdTime(optional): string(date-time)
  Read Only: true

  Time when an alert was created
• employeeId: string
  Id of the employee affected by an alert

  Example: 51
• id(optional): string
  Read Only: true

  The unique id of the object

  Example: 53
• links(optional): array links
• message: string
  Descriptive text of an alert

  Example: Fall detected
• priority: string
  Allowed Values: [ "LOW", "MEDIUM", "HIGH" ]

  Priority of the employee alert

  Example: LOW
• resolvedTime(optional): string(date-time)
  Read Only: true

  Time when an alert was resolved
• status(optional): string
  Read Only: true

  Allowed Values: [ "ACTIVE", "RESOLVED" ]

  Status of the employee alert. Automatically assigned to 'ACTIVE' on backend during creation of the alert. Can be updated.

  Example: ACTIVE

{
    "required":[
        "employeeId",
        "message",
        "priority"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The unique id of the object",
            "readOnly":true,
            "example":"53"
        },
        "status":{
            "type":"string",
            "description":"Status of the employee alert. Automatically assigned to 'ACTIVE' on backend during creation of the alert. Can be updated.",
            "readOnly":true,
            "example":"ACTIVE",
            "enum":[
                "ACTIVE",
                "RESOLVED"
            ]
        },
        "priority":{
            "type":"string",
            "description":"Priority of the employee alert",
            "example":"LOW",
            "enum":[
                "LOW",
                "MEDIUM",
                "HIGH"
            ]
        },
        "employeeId":{
            "type":"string",
            "description":"Id of the employee affected by an alert",
            "example":"51"
        },
        "message":{
            "type":"string",
            "description":"Descriptive text of an alert",
            "example":"Fall detected"
        },
        "createdTime":{
            "type":"string",
            "description":"Time when an alert was created",
            "format":"date-time",
            "readOnly":true
        },
        "resolvedTime":{
            "type":"string",
            "description":"Time when an alert was resolved",
            "format":"date-time",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
  The target resource's URI
• rel: string
  Relation type

{
    "required":[
        "href",
        "rel"
    ],
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Relation type"
        },
        "href":{
            "type":"string",
            "description":"The target resource's URI"
        }
    }
}

Back to Top