Get site
Returns one site whole: the register row plus the panel's zones and the standing hazards, which ride inside the document.
GET /v1/patrol/site/{name}
| Address | https://api.hanzo.ai/v1/patrol/site/{name} |
| Method | GET |
| Operation | get_patrol_site_by_name |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns one site whole: the register row plus the panel's zones and the standing hazards, which ride inside the document. A client asking for a site that is not theirs is 404.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
name | path | string | yes | Name is the site's document name, from the path. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | patrol.patrolSiteOut | ok |
default | problem-details | refused |
200 body — 27 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
data | body | patrol.patrolSite | — | |
data.account | body | string | — | Account is the alarm-panel account number the receiving centre reports. |
data.cameras | body | integer (int64) | — | Cameras is how many cameras are registered here. |
data.category | body | string | — | Category is what kind of premises this is. |
data.client | body | string | — | Client is the customer this site belongs to. |
data.contact | body | string | — | Contact is the keyholder to reach. |
data.eircode | body | string | — | Eircode is the postal code. |
data.hazards | body | string[] | — | Hazards is the standing warnings, present on a single-site read. |
data.keys | body | boolean | — | Keys says whether the operation holds a key set for this site. |
data.lat | body | number (double) | — | Lat is the site's latitude in degrees. |
data.lon | body | number (double) | — | Lon is the site's longitude in degrees. |
data.name | body | string | — | Name is the site's document name and the segment /v1/patrol/site/{name} addresses it by. |
data.notes | body | string | — | Notes is the standing brief for the site. |
data.ref | body | integer (int64) | — | Ref is the site's number in the register. |
data.risk | body | integer (int64) | — | Risk is the assessed risk score. |
data.sector | body | string | — | Sector is the patrol sector the site sits in. |
data.sla | body | integer (int64) | — | SLA is the contracted response time in minutes. |
data.status | body | string | — | Status is ok, fault, alarm or offline. |
data.tier | body | string | — | Tier is the contracted service tier. |
data.town | body | string | — | Town is the town the site is in. |
data.unit | body | string | — | Unit is the call sign of the unit that covers the site, or empty. |
data.visits | body | integer (int64) | — | Visits is how many patrol visits the contract calls for. |
data.zones | body | patrol.patrolZone[] | — | Zones is the panel's detection zones, present on a single-site read. |
data.zones[].device | body | string | — | Device is the detector type. |
data.zones[].location | body | string | — | Location is where in the building the zone is. |
data.zones[].ref | body | string | — | Ref is the zone number the panel reports. |
data.zones[].state | body | string | — | State is the zone's last known condition. |
Failure carries the platform error shape — see Errors.
Examples
hanzo patrol site get <name>import { Configuration, PatrolApi } from 'hanzoai';
const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getPatrolSiteByName({ name: 'name' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).get_patrol_site_by_name(name='name')cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)
resp, _, err := client.PatrolAPI.GetPatrolSiteByName(context.Background()).Execute()
if err != nil {
return err
}use hanzo_client::apis::{configuration::Configuration, patrol_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = patrol_api::get_patrol_site_by_name(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;
ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));
var result = new PatrolApi(client).getPatrolSiteByName();The method above is the one at the current release of the document. [email protected] (npm) was generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl https://api.hanzo.ai/v1/patrol/site/<name> \
-H "Authorization: Bearer $HANZO_API_KEY"MCP declares no tool for patrol — tools/list on https://api.hanzo.ai/v1/mcp names the products it does reach. Use HTTP or an SDK.
How is this guide?