Noodsignaal
Kernplatformduress_acknowledge_incidentNoodsignaalBevestigt een open duress-incident namens de gebruiker: legt vast dat die reageert en kan verdere escalatie stoppen. Alleen open incidenten kunnen worden bevestigd.
Vraag altijd eerst om bevestiging. Roep aan zonder confirm om het incident op te halen, vertel de gebruiker wat die bevestigt en roep pas opnieuw aan met confirm: true nadat de gebruiker heeft ingestemd.
In een workflow, of vanuit een agent, werkt dit alleen als het responsplan van de faciliteit workflows toestaat alarmen te bevestigen, af te handelen en te activeren. Gebruik duress_resolve_incident om een incident af te sluiten.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
incidentId* | string | Incident-ID (inc_...), uit duress_incidents_read list of de trigger van een Duress-workflow. |
note | string | Optionele notitie, bijv. "Onderweg naar de receptie" |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
duress_end_testNoodsignaalBeëindigt direct de lopende duress-test bij een faciliteit, zodat de volgende keer indrukken een echt alarm is. De resultaten volgen ongeveer 10 minuten later, zoals bij elke test.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. |
duress_incidents_readNoodsignaalLeest duress-alarmincidenten (een medewerker drukte op een duress-knop, of een workflow activeerde een alarm): lijsten, de tijdlijn en verzendingen van één incident, een evaluatierapport en de CCTV-beelden rond een alarm.
Statussen: open (nog niemand heeft het bevestigd), acknowledged (iemand reageert), resolved (afgesloten, met een afhandeling: genuine, false_alarm, test of unknown). active betekent open of acknowledged. Testincidenten (isTest) komen van knoptests; testType 'unplanned' is een alarm dat als echt werd geactiveerd en dat een responder als test heeft afgehandeld.
Verzendstatus: sent, acknowledged (de ontvanger heeft bevestigd), failed (zie error), shadow (proefrun, er is niets verzonden). Verzendingen naar de meldkamer worden ook opgeteld onder monitoringCentre. Resultaten noemen personen, maar bevatten nooit telefoonnummers of e-mailadressen. Tijden zijn ISO.
Acties:
- list: Incidenten tonen. Nieuwste eerst. scope: facility (standaard; de opgegeven of verbonden faciliteit) of organisation (elke faciliteit daarin die je kunt zien; standaard de organisatie van de faciliteit).
- get: Incident ophalen. Status, de ingedrukte knoppen, de tijdlijn (keren indrukken, escalaties, bevestigingen, notities) en elke verzendpoging van een melding of naar de meldkamer met het resultaat. Vereist incidentId.
- report: Incidentrapport. Voor een evaluatie: het incident, seconden tot bevestiging en afhandeling, bereikte stappen, elk tijdlijnitem, wat per kanaal is verzonden en wat is mislukt, en of beelden zijn bewaard. Combineer met duress_incidents_write add_note om de evaluatie aan het incident toe te voegen. Vereist incidentId.
- footage_previews: Alarmbeelden. Elke camera in de alarmbeelden: de status, het aantal frames en clips, geüploade clips en het frame dat het dichtst bij het indrukken ligt (posterSeconds). Met cameraId alleen die camera plus de Unix-seconden van elk frame (frameSeconds). Vereist CCTV bij de faciliteit. Vereist incidentId.
- footage_frame: Frame uit alarmbeelden. Eén timelapse-frame uit de alarmbeelden, geretourneerd als afbeelding: een bewaarde kopie zodra beelden zijn bewaard, anders het live frame binnen het alarmvenster. seconds is een posterSeconds- of frameSeconds-waarde uit footage_previews. Vereist incidentId, cameraId, seconds.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "list" | "get" | "report" | "footage_previews" | "footage_frame" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
scope | "facility" | "organisation" | Standaard facility (list) |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. (list) |
organisationId | string | Voor scope organisation. Standaard de organisatie van de faciliteit. (list) |
status | "active" | "open" | "acknowledged" | "resolved" | active is open of acknowledged (list) |
from | string | ISO-datum en -tijd: incidenten die op of na dit moment zijn geopend (list) |
to | string | ISO-datum en -tijd: incidenten die op of vóór dit moment zijn geopend (list) |
limit | integer | Items per pagina (standaard 25, maximaal 100) (list) |
cursor | string | nextCursor van de vorige pagina (list) |
incidentId | string | Incident-ID (inc_...), uit duress_incidents_read list of de trigger van een Duress-workflow. (get, report, footage_previews, footage_frame) |
cameraId | string | Een camera in de alarmbeelden, uit footage_previews (footage_previews, footage_frame) |
seconds | integerstring | Het tijdstip van het frame als Unix-seconden van 10 cijfers (footage_frame) |
duress_incidents_writeNoodsignaalDuress ConfigurationWijzigt een duress-incident zonder het alarm zelf aan te raken: geeft het een naam, voegt notities van medewerkers toe en bewaart of geeft de CCTV-beelden eromheen vrij. Niemand wordt gewaarschuwd. Gebruik duress_acknowledge_incident, duress_resolve_incident of duress_post_update om te bevestigen, af te handelen of responders te informeren.
Acties:
- rename: Incident een naam geven. Geeft het incident een naam zodat het later makkelijk te vinden is, bijv. "Agressieve bezoeker bij de balie". Een lege naam of null verwijdert de naam. Namen worden getoond in de Duress-console en rapporten. Vereist incidentId.
- add_note: Notitie toevoegen. Voegt een notitie toe aan de tijdlijn van het incident, bijv. wat de gebruiker aantrof of wie aanwezig was. Bij elke status; alleen medewerkers zien notities en ze wijzigen het incident niet. Schrijf de notitie in de woorden van de gebruiker en laat de formulering eerst door de gebruiker bevestigen. Vereist incidentId, note.
- keep_footage: Alarmbeelden bewaren. Bewaart de CCTV-beelden rond een afgehandeld echt alarm zodat ze niet samen met normale opnamen worden verwijderd, met de minuten en camera's uit het responsplan. Gebeurt een paar minuten later, na het uploaden. Niet voor tests, open alarmen of beelden die al zijn bewaard of vrijgegeven. Vereist incidentId.
- release_footage: Bewaarde beelden vrijgeven. Geeft de beelden vrij die voor een alarm zijn bewaard: clips vallen weer onder de normale bewaartermijn en bewaarde frames worden verwijderd, zodat ze niet meer te bekijken zijn zodra normale opnamen verlopen. Vereist Duress Configuration bij de faciliteit. Vereist incidentId. Vraagt om bevestiging.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "rename" | "add_note" | "keep_footage" | "release_footage" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
incidentId | string | Incident-ID (inc_...), uit duress_incidents_read list of de trigger van een Duress-workflow. |
name | stringnull | De naam; leeg of null verwijdert hem (rename) |
note | string | De notitie (add_note) |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
duress_lift_lockdownNoodsignaalHeft de lockdown van een duress-alarm op: de deuren die zijn vergrendeld, laten weer mensen binnen. Werkt ongeacht de status van het alarm.
Vraag eerst om bevestiging. Roep aan zonder confirm om de lockdown te bekijken, informeer de gebruiker en roep opnieuw aan met confirm: true zodra die instemt.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
incidentId* | string | Incident-ID (inc_...), uit duress_incidents_read list of de trigger van een Duress-workflow. |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
duress_post_updateNoodsignaalPlaatst een update voor de mensen die op een duress-alarm reageren, bijv. "De politie is onderweg" of "Alles veilig, de persoon is vertrokken". De update verschijnt op hun alarmpagina en in de Duress-app, en bij een echt alarm kan het responsplan hem ook per sms sturen naar iedereen die al een sms over het alarm heeft gekregen. Updates kunnen worden geplaatst tot 24 uur nadat het alarm is afgehandeld.
Vraag eerst om bevestiging. Roep aan zonder confirm om het incident te controleren, toon de gebruiker de exacte formulering en roep opnieuw aan met confirm: true zodra die instemt. Gebruik voor iets wat alleen medewerkers mogen zien in plaats daarvan duress_incidents_write add_note.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
incidentId* | string | Incident-ID (inc_...), uit duress_incidents_read list of de trigger van een Duress-workflow. |
text* | string | De update, woord voor woord |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
duress_raise_alarmNoodsignaalActiveert een echt duress-alarm bij de faciliteit, alsof er op een knop is gedrukt: het responsplan wordt uitgevoerd (mensen worden gewaarschuwd, escalatie en herinneringen volgen, responsacties worden uitgevoerd) en het alarm vermeldt dat het door deze workflow is geactiveerd, met de reden.
- reason: wat er is gebeurd, bijv. "Deur opengebroken bij de achteruitgang" (maximaal 200 tekens).
- deviceSerialNumber: optioneel. Een knop waarvan de locatie wordt gebruikt; alleen dan wordt ook de meldkamer ingelicht, met de zone van die knop.
Alleen als workflowstap, bij faciliteiten waarvan het responsplan workflows toestaat alarmen te bevestigen, af te handelen en te activeren. Zolang het alarm van deze workflow open is, wordt er geen nieuw alarm geactiveerd; in plaats daarvan wordt dat alarm geretourneerd.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. |
reason* | string | Wat er is gebeurd |
deviceSerialNumber | string | Een knop bij de faciliteit (optioneel) |
duress_reports_readNoodsignaalDuress ConfigurationDuress-compliancerapportage voor een faciliteit, merk of organisatie: reactietijden (P50/P95), incidenten per afhandeling en percentage valse alarmen, testdekking en faciliteiten met achterstallige tests, uptime van knoppen, succes van verzending naar de meldkamer en een export per incident. Plus de niet-afgeleverde meldingen van het laatste alarm bij één faciliteit.
Dagen zijn in lokale tijd van de faciliteit; perioden van meer dan 400 dagen worden ingekort (range.capped). Echte en testincidenten worden apart geteld. Duur is in ms (p50Ms, p95Ms). Merkrapporten omvatten alleen de faciliteiten waartoe je toegang hebt, tenzij je organisatiebrede toegang hebt (scope.restrictedToAccessibleFacilities).
Acties:
- overview: Overzicht van het Duress-rapport. Totalen, maandelijkse trend en statistieken per organisatie, merk en faciliteit (incidents, testCoverage, deviceUptime, deliveries). Faciliteiten zijn gepagineerd.
- compliance_summary: Duress-compliancesamenvatting. Wat de compliance-pdf toont: testdekking met faciliteiten met achterstallige tests, uptime van knoppen, succes van verzending, recente tests (testHistory) en per faciliteit de laatste test, oefening en het laatste echte alarm, met de uptime van elke knop. Faciliteiten zijn gepagineerd.
- incident_export: Export van Duress-incidenten. Eén rij per incident, oudste eerst, met de kolommen van de CSV-export: faciliteit, test of echt, status, afhandeling, lokale tijden, seconden tot bevestiging en afhandeling, wie heeft bevestigd en afgehandeld, knoppen en aantallen verzendingen.
- delivery_problems: Niet-afgeleverde alarmmeldingen. Het laatste alarm of de laatste test van de faciliteit (met het hele testvenster) en de meldingen die nooit zijn aangekomen, per kanaal. problems is null als alles is aangekomen. Vereist daar Duress of Duress Configuration.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "overview" | "compliance_summary" | "incident_export" | "delivery_problems" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
scope | "facility" | "brand" | "organisation" | Standaard: de meest specifieke opgegeven id, anders de verbonden faciliteit. (overview, compliance_summary, incident_export) |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. |
brandId | string | Merk-ID, voor de sjabloon van het merk in plaats van een faciliteit (overview, compliance_summary, incident_export) |
organisationId | string | Vereist organisatiebrede toegang tot Duress (overview, compliance_summary, incident_export) |
from | string | Eerste dag, YYYY-MM-DD in lokale tijd van de faciliteit (standaard 30 dagen vóór to) (overview, compliance_summary, incident_export) |
to | string | Laatste dag, YYYY-MM-DD in lokale tijd van de faciliteit, inclusief (standaard vandaag) (overview, compliance_summary, incident_export) |
limit | integer | Items per pagina (standaard 25, maximaal 100) (overview, compliance_summary, incident_export) |
cursor | string | nextCursor van de vorige pagina (overview, compliance_summary, incident_export) |
duress_resolve_incidentNoodsignaalHandelt een duress-incident af: sluit het alarm, stopt de escalatie en legt de uitkomst vast. Open en bevestigde incidenten kunnen worden afgehandeld.
- disposition:
genuine(een echte noodsituatie),false_alarm,testofunknown. - note: wat er is gebeurd. Verplicht bij een echt alarm.
Vraag altijd eerst om bevestiging. Roep aan zonder confirm om het incident op te halen, vertel de gebruiker welk alarm die afsluit en met welke uitkomst, en roep pas opnieuw aan met confirm: true nadat de gebruiker heeft ingestemd.
In een workflow, of vanuit een agent, werkt dit alleen als het responsplan van de faciliteit workflows toestaat alarmen te bevestigen, af te handelen en te activeren.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
incidentId* | string | Incident-ID (inc_...), uit duress_incidents_read list of de trigger van een Duress-workflow. |
disposition* | "genuine" | "false_alarm" | "test" | "unknown" | De uitkomst |
note | string | Wat er is gebeurd. Verplicht als disposition genuine is. |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
duress_settings_readNoodsignaalDuress ConfigurationLeest Duress-instellingen: responsplannen (wie wordt gewaarschuwd, in welke volgorde en hoe, bij een faciliteit of als merksjabloon), het uitgewerkte plan dat de alarmengine daadwerkelijk gebruikt, de personen en rollen die kunnen worden toegevoegd, apparaatmeldingen (batterij, offline, dekking en verzendproblemen), contactregels en planstatus van het merk, een knoppenoverzicht van een merk of organisatie, en hoe alarmen naar de meldkamer gaan.
Een faciliteit volgt de sjabloon van haar merk (anders van haar organisatie), breidt die uit met extra contactpersonen (mode extend) of vervangt die door een eigen plan (mode replace). Wijzig instellingen met duress_settings_write. Tijden zijn ISO.
Acties:
- response_plan: Responsplan. Het plan dat geldt bij een faciliteit (effective) en wat elk niveau bevat (sources: facility, brand, organisation), of met alleen brandId de sjabloon van het merk. Contactpersonen zijn zoals opgeslagen, klaar om te bewerken en terug op te slaan.
- resolved_plan: Uitgewerkt plan. Wie de alarmengine bij de faciliteit benadert, laag voor laag: rollen uitgewerkt tot personen, kanalen waarop elk bereikbaar is, vertragingen en waarschuwingen die vóór een alarm moeten worden opgelost. Alleen namen, geen telefoonnummers of e-mailadressen.
- contact_options: Contactopties. Personen en rollen die kunnen worden toegevoegd aan het plan van de faciliteit (vereist daar Duress Configuration), of met alleen brandId aan de sjabloon van het merk, na toepassing van de contactregels van het merk.
- device_alerts: Apparaatmeldingen. Wie wordt ingelicht over lage batterijen, offline knoppen, verloren dekking en mislukte verzendingen: de regels op elk niveau en de uitgewerkte ontvangers van de faciliteit, of met alleen brandId de regels van het merk.
- contact_rules: Contactregels van het merk. Welke rollen faciliteiten van het merk aan plannen mogen toevoegen: allowAllExcept verbergt de vermelde rollen, manual biedt alleen die aan. Vereist dezelfde rechten als het bewerken van het merkplan. Vereist brandId.
- plan_status: Planstatus van het merk. Elke faciliteit van het merk: of die de sjabloon volgt, uitbreidt of een eigen plan heeft, hoeveel contactpersonen er zijn toegevoegd en de waarschuwingen van het plan. Vereist brandId.
- buttons_summary: Knoppenoverzicht. Elke faciliteit in een merk of organisatie: aantallen knoppen, lage batterijen en offline knoppen, de volgende en laatste test. De gegevens van de overzichten in Brands & Customisation en de organisatie.
- monitoring: Routering naar de meldkamer. Hoe alarmen de faciliteit verlaten: eaAlarmType none, cid (een melding aan de meldkamer via eaAlarmProvider) of relay (een bekabeld paneel via eaRelayModel), en de providers die kunnen worden gebruikt.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "response_plan" | "resolved_plan" | "contact_options" | "device_alerts" | "contact_rules" | "plan_status" | "buttons_summary" | "monitoring" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. (response_plan, resolved_plan, contact_options, device_alerts, monitoring) |
brandId | string | Merk-ID, voor de sjabloon van het merk in plaats van een faciliteit (response_plan, contact_options, device_alerts, contact_rules, plan_status, buttons_summary) |
organisationId | string | Organisatie-ID (buttons_summary) |
duress_settings_writeDuress ConfigurationWijzigt Duress-instellingen: responsplannen (bij een faciliteit, of de sjabloon van een merk of organisatie), apparaatmeldingen, contactregels van het merk en hoe alarmen naar de meldkamer gaan. Elke wijziging vraagt om bevestiging, omdat die bepaalt wie wordt gewaarschuwd.
Geef één van facilityId (standaard: de verbonden faciliteit), brandId of organisationId door. Faciliteitplannen vereisen daar Duress Configuration; sjablonen vereisen een organisatiebeheerder met Duress Configuration, of voor een merk Duress Configuration bij elke faciliteit van dat merk. Lees eerst met duress_settings_read.
Acties:
- save_response_plan: Responsplan opslaan. Lagen van contactpersonen die afterSeconds na het indrukken worden gewaarschuwd (oplopend, de eerste meestal 0), ackRequired, reminders en responseActions. Een faciliteit kan in plaats daarvan haar sjabloon uitbreiden (mode extend) met aanvullingen. Weggelaten velden behouden hun opgeslagen waarden; responseActions worden per actie samengevoegd. Vraagt om bevestiging.
- remove_response_plan: Responsplan verwijderen. Verwijdert het plan dat op dit niveau is opgeslagen, zodat een faciliteit weer haar sjabloon volgt en een merk terugvalt op dat van de organisatie. Vraagt om bevestiging.
- save_device_alerts: Apparaatmeldingen opslaan. Vervangt de regels voor apparaatmeldingen op dit niveau: maximaal 10 regels, elk een set gebeurtenissen en contactpersonen (push, sms of email). Behoud de regel-id's die je hebt gelezen met duress_settings_read device_alerts. Vereist rules. Vraagt om bevestiging.
- remove_device_alerts: Apparaatmeldingen verwijderen. Verwijdert de regels voor apparaatmeldingen op dit niveau, zodat het weer het eerstvolgende hogere niveau volgt. Vraagt om bevestiging.
- save_contact_rules: Contactregels van het merk opslaan. Welke rollen de faciliteiten van het merk aan plannen kunnen toevoegen: allowAllExcept verbergt roleIds, manual biedt alleen roleIds aan. Al opgeslagen contactpersonen blijven staan; uitgewerkte plannen worden vernieuwd. Vereist brandId, mode, roleIds. Vraagt om bevestiging.
- save_monitoring: Routering naar de meldkamer opslaan. Waar alarmen naartoe gaan: eaAlarmType none, cid (vereist eaAlarmProvider, een van de providers die duress_settings_read monitoring toont) of relay (eaRelayModel). Vereist Duress Configuration bij de faciliteit. Vereist eaAlarmType. Vraagt om bevestiging.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "save_response_plan" | "remove_response_plan" | "save_device_alerts" | "remove_device_alerts" | "save_contact_rules" | "save_monitoring" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. (save_response_plan, remove_response_plan, save_device_alerts, remove_device_alerts, save_monitoring) |
brandId | string | Merk-ID, voor de sjabloon van het merk in plaats van een faciliteit (save_response_plan, remove_response_plan, save_device_alerts, remove_device_alerts, save_contact_rules) |
organisationId | string | Organisatie-ID, voor de sjabloon van de organisatie (save_response_plan, remove_response_plan, save_device_alerts, remove_device_alerts) |
mode | "replace" | "extend" | Alleen faciliteitplannen: replace (eigen lagen) of extend (aanvullingen op de sjabloon) (save_response_plan, save_contact_rules) |
tiers | array | De lagen van het plan (mode replace en sjablonen) (save_response_plan) |
additions | array | Mode extend: extra contactpersonen per sjabloonlaag (tierId en afterSeconds daaruit) (save_response_plan) |
ackRequired | boolean | Of de escalatie doorgaat totdat iemand bevestigt (save_response_plan) |
reminders | objectnull | Meldingen elke everySeconds herhalen (0 schakelt ze uit) tot stopAfterSeconds (save_response_plan) |
responseActions | object | Acties op naam, elk { enabled, ... }: unlockOnAcknowledge (doorIds), lockdown, staffScreenAlerts, buttonAcknowledge, dashboardCctv, dashboardDoorControls, dashboardResolve, updateTexts, aiSummary, workflowControl, retainFootage (minutesBefore, minutesAfter, cameras) (save_response_plan) |
rules | array | De regels; een lege lijst slaat er geen op (waarschuwt hier niemand) (save_device_alerts) |
roleIds | array | Rol-id's waarop de modus van toepassing is (save_contact_rules) |
eaAlarmType | "none" | "cid" | "relay" | none, cid of relay (save_monitoring) |
eaAlarmProvider | stringnull | Voor cid: de providercode (save_monitoring) |
eaRelayModel | "none" | "numato-rl80001" | Voor relay: het relaisbord (save_monitoring) |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
duress_start_lockdownNoodsignaalZet de faciliteit in lockdown voor een duress-alarm: geen enkele deur laat nog mensen binnen totdat de lockdown wordt opgeheven (duress_lift_lockdown, of via de console). Een alarm krijgt altijd maar één lockdown.
Nooit voor test- of afgehandelde alarmen. Vereist Door/Gate Access bij de faciliteit.
Vraag eerst om bevestiging. Roep aan zonder confirm om het incident te controleren, vertel de gebruiker dat elke deur wordt vergrendeld en roep opnieuw aan met confirm: true zodra die instemt.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
incidentId* | string | Incident-ID (inc_...), uit duress_incidents_read list of de trigger van een Duress-workflow. |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
duress_start_testNoodsignaalStart direct een duress-test bij een faciliteit. Tot de test eindigt, is elke keer indrukken een test en geen echt alarm:
walk: medewerkers drukken op elke knop; alleen de eerste stap van het responsplan wordt gewaarschuwd, met het label TEST.drill: het hele responsplan wordt uitgevoerd, met het label TEST.
De testcontactpersonen van de faciliteit krijgen te horen dat de test is gestart en ontvangen de resultaten ongeveer 10 minuten nadat die is geëindigd. Eén test tegelijk per faciliteit. Beëindig de test eerder met duress_end_test; plan tests vooruit met duress_tests_write.
Vraag eerst om bevestiging. Roep aan zonder confirm, vertel de gebruiker dat indrukken gedurende durationMinutes geen echte alarmen activeert en roep opnieuw aan met confirm: true zodra die instemt. In een workflow, of vanuit een agent, werkt dit alleen als het responsplan van de faciliteit workflows toestaat alarmen te bevestigen, af te handelen en te activeren.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. |
type | "walk" | "drill" | walk (standaard) of drill |
durationMinutes | integer | Hoe lang indrukken als test geldt (standaard 60) |
monitoringCentreMode | "test-codes" | "none" | `test-codes` stuurt de meldkamer testsignalen; `none` stuurt niets |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
duress_tests_readNoodsignaalDuress ConfigurationLeest tests van duress-knoppen: de schema's waarmee ze worden gepland (walk, comms of drill, eenmalig of terugkerend, voor een organisatie, merken of faciliteiten), de testvensters die ze bij elke faciliteit aanmaken (scheduled, active, completed, cancelled, plus ad-hoctests) en de resultaten van een venster (welke knoppen zijn ingedrukt of gemist, wie is ingelicht, signalen naar de meldkamer, bevestigingstijden).
Wie een test heeft gepland, gewijzigd of geannuleerd, wordt weggelaten; ontvangers van verzendingen worden afgeschermd. Tijden zijn ISO; localDate en localStartTime zijn in de tijdzone van de faciliteit. Plan of wijzig tests met duress_tests_write; start er direct een met duress_start_test.
Acties:
- schedules: Testschema's. scope facility (standaard; elk schema dat de faciliteit omvat, inclusief gedeelde schema's die ze overslaat of vervangt), brand (brandId) of organisation (standaard: die van de faciliteit). Nieuwste wijziging eerst.
- windows: Testvensters. De testvensters van een faciliteit van
fromtotto(standaard ongeveer een week terug tot een maand vooruit), of met alleen organisationId de komende vensters van de organisatie voor al haar faciliteiten. - results: Testresultaten. Een venster en de resultaten: opgeslagen zodra verzonden, live berekend terwijl een test loopt (de checklist van de walk-test), null voor geplande of geannuleerde vensters. Vereist Duress bij de faciliteit. Vereist startsAtKey.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "schedules" | "windows" | "results" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
scope | "facility" | "brand" | "organisation" | Standaard facility (schedules) |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de faciliteit is die je bedoelt. |
brandId | string | Merk-ID, voor de sjabloon van het merk in plaats van een faciliteit (schedules) |
organisationId | string | Voor scope organisation (schedules, windows) |
includeCancelled | boolean | Geannuleerde meenemen (schedules, windows) |
limit | integer | Items per pagina (standaard 25, maximaal 100) (schedules, windows) |
cursor | string | nextCursor van de vorige pagina (schedules, windows) |
from | string | ISO-datum en -tijd (windows) |
to | string | ISO-datum en -tijd (windows) |
startsAtKey | string | Het testvenster (startsAtKey), uit duress_tests_read windows (results) |
duress_tests_writeDuress ConfigurationNoodsignaalPlant, wijzigt en annuleert schema's voor duress-tests, bepaalt hoe één faciliteit een gedeeld schema volgt en annuleert één aankomend testvenster. Elke wijziging plant of herschrijft toekomstige vensters en mailt de betrokkenen, dus elke actie vraagt om bevestiging.
Schema's vereisen Duress Configuration voor hun hele doel (een organisatiebeheerder voor organisatiebrede schema's). Tijden zijn in de tijdzone van elke faciliteit. Lees eerst schema's en vensters met duress_tests_read; start nu een test met duress_start_test.
Acties:
- create_schedule: Een testschema plannen. Plant vensters tot ongeveer een jaar vooruit bij elke faciliteit in target en mailt een boekingsbevestiging. Vereist name, type, target, startDate, localStartTime en recurrence. Vereist name, type, target, startDate, localStartTime, recurrence. Vraagt om bevestiging.
- update_schedule: Een testschema wijzigen. Weggelaten velden behouden hun waarden. Toekomstige vensters worden herschreven (gestarte vensters blijven staan) en betrokkenen krijgen een wijzigingsbericht. Gebruik daarna de ownerScope uit het resultaat. Vereist ownerScope, scheduleId. Vraagt om bevestiging.
- cancel_schedule: Een testschema annuleren. Annuleert het schema en de toekomstige vensters en mailt de annulering. Faciliteiten met een eigen kopie behouden die. Vereist ownerScope, scheduleId. Vraagt om bevestiging.
- set_facility_override: Een gedeeld schema voor één faciliteit wijzigen. mode follow (het gedeelde schema hier weer uitvoeren), skip (het hier stoppen) of own (het hier vervangen door een kopie op basis van schedule). Vereist alleen Duress Configuration bij die faciliteit. Vereist ownerScope, scheduleId, mode. Vraagt om bevestiging.
- cancel_window: Eén testvenster annuleren. Annuleert één geplande test bij een faciliteit (het schema loopt door) en mailt de betrokkenen. Vereist Duress bij de faciliteit; een actieve test beëindig je in plaats daarvan met duress_end_test. Vereist startsAtKey. Vraagt om bevestiging.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
action* | "create_schedule" | "update_schedule" | "cancel_schedule" | "set_facility_override" | "cancel_window" | Wat er moet gebeuren; elke actie wordt beschreven in de toolbeschrijving. |
name | string | Getoond in e-mails en de agenda (create_schedule, update_schedule) |
type | "walk" | "comms" | "drill" | walk (elke knop indrukken), comms (één druk per meldpad) of drill (een geoefende respons) (create_schedule, update_schedule) |
target | object | Welke faciliteiten: de hele organisatie, brandIds of facilityIds (create_schedule, update_schedule) |
startDate | string | Eerste keer, YYYY-MM-DD in de tijdzone van elke faciliteit (create_schedule, update_schedule) |
localStartTime | string | HH:mm in de tijdzone van elke faciliteit (create_schedule, update_schedule) |
durationMinutes | integer | Standaard 60 (create_schedule, update_schedule) |
recurrence | "once" | "monthly" | "quarterly" | "twice-yearly" | "yearly" | once, monthly, quarterly, twice-yearly of yearly (create_schedule, update_schedule) |
repeatOn | objectnull | Herhalen op de n-de weekdag van de maand in plaats van dezelfde datum; null wist dit (create_schedule, update_schedule) |
monitoringCentreMode | "test-codes" | "none" | test-codes verstuurt signalen als tests; none houdt de meldkamer erbuiten (create_schedule, update_schedule) |
extraEmails | array | Krijgen ook de boeking, herinneringen en resultaten per e-mail (create_schedule, update_schedule) |
organisationId | string | Standaard: de organisatie van de verbonden faciliteit (create_schedule, update_schedule, cancel_schedule, set_facility_override) |
ownerScope | string | Uit duress_tests_read schedules, bijv. brand#b-123; kan veranderen als het doel verandert (update_schedule, cancel_schedule, set_facility_override) |
scheduleId | string | Uit duress_tests_read schedules (update_schedule, cancel_schedule, set_facility_override) |
facilityId | string | Faciliteit-ID. Optioneel als de verbonden faciliteit de bedoelde is. (set_facility_override, cancel_window) |
mode | "follow" | "skip" | "own" | follow, skip of own (set_facility_override) |
schedule | object | mode own: de velden van de kopie (target is altijd deze faciliteit); weggelaten velden komen uit het gedeelde schema (set_facility_override) |
startsAtKey | string | Het testvenster (startsAtKey), uit duress_tests_read windows (cancel_window) |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |
duress_unlock_doorsNoodsignaalOntgrendelt de deuren bij een duress-alarm, bijv. om politie of EHBO binnen te laten: de deuren die aan de ingedrukte knop gekoppeld zijn, anders de deuren van het responsplan. Laat doorIds weg voor alle deuren, of noem er een aantal. Elke ontgrendeling staat op de tijdlijn van het incident en in de Toegangslogboeken.
Nooit voor test- of afgehandelde alarmen. Vereist Door/Gate Access bij de faciliteit.
Eerst bevestigen. Roep aan zonder confirm om te zien welke deuren zouden ontgrendelen, vertel dit de gebruiker en roep opnieuw aan met confirm: true zodra die akkoord gaat.
Parameters
| Naam | Type | Beschrijving |
|---|---|---|
incidentId* | string | Incident-ID (inc_...), uit duress_incidents_read list of de trigger van een Duress-workflow. |
doorIds | array | Een deel van de deuren die zonder confirm zijn getoond. Weglaten voor alle deuren. |
confirm | boolean | Alleen instellen nadat de gebruiker het voorbeeld van de eerste aanroep heeft bevestigd |