Get Alarm Entry Status

  • Description* This interface retrieves the current status of alarm entries.

  • Request URLs: (Choose one)

    URL1:[Host Server]/api/v2/box/{boxId}/alarm/defs

    URL2:[Host Server]/api/v2/box/alarm/defs?boxNo={boxNo}

  • Address Parameters Description

    Field Type Description
    Host Server string SeeExplanation of terms
    boxid Long Find it in Get FGate list interface: boxRegs->box->id

  • Request

    GET

  • Headers

    Field Type Description
    Authorization string "Bearer " + Access Token obtained from the login interface

  • Body

    NULL

  • Successful Response

    Field Type Description
    id string ID of the alarm entry
    code int Code of the alarm entry
    name string Name of the alarm entry
    boxId string ID of the box, same as the boxId parameter in the URL
    boxNo string Serial number of the FGate
    alarmMsg string Alarm message
    alarmState int Alarm state: 0: Unknown, 1: Triggered, 2: Restored, 4: Confirmed
    lastTriggeredTime dateTime Trigger time
    lastRecoveredTime dateTime Restore time
    valueOnLastEvent Object The value when the alarm was last triggered

  • Return Codes

    Field Description
    200 Successful execution
    401 Access token expired
    404 Interface does not exist, please check the URL
    429 Access the interface so frequently, see 429 Status code