Access Scenario Object

Attribute	Type	Description
scenario_id	String(Unique)	Unique ID of the Scenario.
name	String	Name of the Scenario.
message	String	Emergency message that will be displayed in Command and in configured Alerts when the Scenario is active.
type	String	The Scenario's type, such as "lockdown".
sites	List(String)	IDs of Sites this Scenario applies to.
site_count	Integer	Number of Sites this Scenario applies to.
state	String	Either ACTIVE or INACTIVE.
doors_to_lock	List(String)	IDs of Doors that will lock when this Scenario is activated.
user_groups_with_enable_access	List(String)	IDs of Access Groups that are given permission to activate the scenario.
user_groups_with_disable_access	List(String)	IDs of Access Groups that are given permission to release the scenario.
user_groups_with_door_access	List(String)	IDs of Access Groups that are given permission to unlock doors when the scenario is active.

Access Scenario Object

{
  	"scenario_id": STR(UNIQUE),
  	"name": STR,
  	"message": STR,
  	"type": STR,
		"sites": LIST(STR),
  	"site_count": INT,
		"state": STR,
  	"doors_to_lock": LIST(STR),
		"user_groups_with_enable_access": LIST(STR),
    "user_groups_with_disable_access": LIST(STR),
    "user_groups_with_door_access": LIST(STR)
}

Example

{
    "doors_to_lock": [
        "a1bdd7a6-4392-4116-9853-048587a16ebb",
        "a57353a8-5e03-4a0c-a945-96adde83017d"
    ],
    "message": "Your emergency message.",
    "name": "Central High School Lockdown",
    "scenario_id": "2a9d482a-f289-48ef-a462-f89f85f6ac81",
    "site_count": 2,
    "sites": [
        "caf27388-8103-4a0a-9b91-3e0746510989",
        "9322726d-836f-4dc6-876c-f75c09b75cbd"
    ],
    "state": "INACTIVE",
    "type": "lockdown",
    "user_groups_with_disable_access": [
        "c36986bf-66b2-4035-8f07-ce80b8279476"
    ],
    "user_groups_with_door_access": [
        "9a0573dc-1fd6-478b-bb56-c9a8a668b061"
    ],
    "user_groups_with_enable_access": [
        "c36986bf-66b2-4035-8f07-ce80b8279476"
    ]
}