Proximity Webservice

Update proximity sensor details

Update details for a proximity tag

post/api/proximity/updateDetails

Request

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

deletedUpdatedboolean nullable

Whether the deleted status has been updated

descriptionstring nullable

Description of the proximity tag

descriptionUpdatedboolean nullable

Whether the description has been updated

imageUrlstring nullable

URL of the image for the proximity tag

imageUrlUpdatedboolean nullable

Whether the image URL has been updated

namestring nullable

Name of the proximity tag

nameUpdatedboolean nullable

Whether the name has been updated

policyUuidstring RUUID nullable

base 64 (url-safe) uuid string

policyUuidUpdatedboolean nullable

Whether the policy UUID has been updated

uuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "description": "John Doe's employee badge",
  "descriptionUpdated": true,
  "imageUrl": "https://example.com/badge-image.jpg",
  "name": "Employee Badge 001",
  "nameUpdated": true,
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "policyUuidUpdated": true,
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

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.