Alert Monitoring Webservice

Create custom PIN for location

Create a custom PIN for alert monitoring at a specific location.

post/api/alertmonitoring/createCustomPinForLocation

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/alertmonitoring/createCustomPinForLocation
  • 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

descriptionstring nullable

Description of the PIN

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

namestring nullable

Name for the PIN

pinstring nullable

Custom PIN code to be created

Example request

{
  "description": "Custom PIN for main entrance access",
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "name": "Custom Main Entrance PIN",
  "pin": "5678"
}

Response

OK

alreadyExistsboolean nullable

Indicates whether the PIN already exists

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.