Policy Webservice

Pause track alerts for a stable track id across a location

Pause track alerts for a single reID stableTrackId across a whole location until duration elapses

post/api/policy/pauseTrackAlertsForLocation

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/policy/pauseTrackAlertsForLocation
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

durationSecinteger nullable

Duration in seconds to pause track alerts

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

policyAlertUuidstring RUUID nullable

base 64 (url-safe) uuid string

scheduledTimestampSecinteger nullable

Scheduled timestamp in seconds for when to begin the pause

trackIdinteger nullable

reID stableTrackId to pause track alerts for

Example request

{
  "durationSec": 3600,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "policyAlertUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "scheduledTimestampSec": 1640995200
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.