Reports progress from a request to clear occupants from a GlobalArea.
Overview of GlobalAreaClearResponse goes here.
GlobalAreaClearResponse
| Field | Type | Inherited from | Description |
|---|---|---|---|
| Cleared | Int32 | GlobalAreaClearResponse | Number of occupancy links successfully removed. |
| Error | String | GlobalAreaClearResponse | Error code when the request encountered an infrastructure failure. |
| Failed | Int32 | GlobalAreaClearResponse | Number of occupants whose clear operation failed. |
| FailedPersonIds | String[] | GlobalAreaClearResponse | Person keys for occupants whose clear operation failed. |
| HasMore | Boolean | GlobalAreaClearResponse | Whether occupants remain for a subsequent clear request. |
| Message | String | GlobalAreaClearResponse | Additional details when the request encountered an infrastructure failure. |
| Queued | Int32 | GlobalAreaClearResponse | Number of occupants whose APB clear commands were queued on every linked controller. |
| QueuedCommands | Int32 | GlobalAreaClearResponse | Total number of APB clear commands queued across all linked controllers. |
| Retryable | Boolean | GlobalAreaClearResponse | Whether retrying this operation may succeed. |
| Selected | Int32 | GlobalAreaClearResponse | Number of occupants selected for this request. |
| Skipped | Int32 | GlobalAreaClearResponse | Number of occupants skipped because their occupancy snapshot changed. |
{
"Cleared" : "Int32",
"Error" : "String",
"Failed" : "Int32",
"FailedPersonIds" : "String[]",
"HasMore" : "Boolean",
"Message" : "String",
"Queued" : "Int32",
"QueuedCommands" : "Int32",
"Retryable" : "Boolean",
"Selected" : "Int32",
"Skipped" : "Int32"
}