Alert Monitoring Webservice

Create PIN for location

Create a PIN for alert monitoring at a specific location.

post/api/alertmonitoring/createPinForLocation

Request

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

Example request

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

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
pinstring nullable

The generated PIN code

warningMsgstring nullable

Example response

{
  "pin": "1234"
}

Changes

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