Documentation

Guardian Protection Services

Create and maintain the customer's monitoring account at Guardian Protection Services (a central-station integration). All actions run against POST /customers/{id}/... and require the customer's monitoring company to be an enabled Guardian integration; the site data always comes from the customer record.

Gated by the Guardian Protection permission at the customer's location.

Call order

  1. Ensure the customer's equipment and contacts are complete in SecurityTrax — the create pushes them to Guardian along with the site data.
  2. guardian_options — fetch the five type catalogs (ownership, sale, location, site system, service types) and pick an id from each.
  3. guardian_save_account — creates the account; the engine stores the account and central-station numbers on the customer and pushes equipment + contacts. 409 if already linked.
  4. Whenever the customer's site data, equipment, or contacts change: guardian_resync re-pushes the linked account (409 if not linked).

Action reference

Create this customer's monitoring account at Guardian Protection Services

POST /{profile}/user/v4/customers/{id}/guardian_save_account

Field Required Type Description
ownership_type_id Yes string Ownership type id (guardian_options).
sale_type_id Yes string Sale type id (guardian_options).
location_id Yes string Guardian location id (guardian_options) — Guardian's location catalog, not a SecurityTrax location.
site_system_type_id Yes string Site system type id (guardian_options).
service_type_id Yes string Service type id (guardian_options).
service_type_price Yes string The monthly service price for the selected service type.

Re-push this customer's linked Guardian account (site, equipment, contacts)

POST /{profile}/user/v4/customers/{id}/guardian_resync

Field Required Type Description
ownership_type_id No string Updated ownership type id, if changing.
sale_type_id No string Updated sale type id, if changing.
location_id No string Updated Guardian location id, if changing.
site_system_type_id No string Updated site system type id, if changing.
service_type_id No string Updated service type id, if changing.
service_type_price No string Updated service price, if changing.

Discover the Guardian account-type options for this customer (live)

POST /{profile}/user/v4/customers/{id}/guardian_options

No request body.

Failure semantics

Pre-flight problems are 409 (wrong/missing provider or monitoring company, lead where not permitted, already/not provisioned, no order) or 402 (integration disabled); partner rejections are 422 carrying the partner's message; an unreachable partner is 502 and never persists anything.

Related

Ask about the docs
Ask about the docs
Answers from the SecurityTrax documentation

Ask about a feature, setting, or workflow.

Answers come from the documentation. Double-check anything important. AI features are subject to the AI Terms.