Org Webservice

Update organization data retention settings

Update org-level retention (in days) for face events and license plate events, covering both the event metadata and the associated image data. Face values must be between 1 and 730 days; license plate values between 1 and 365 days (orgs grandfathered on the legacy 2-year value may resend it unchanged, but cannot return to it once changed). A null value resets that data class to the platform default.

post/api/org/updateDataRetentionSettings

Request

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

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

Example response

{
  "org": {
    "companyLogoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "keypadLogoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "managingPartnerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rhombusKeyLogoUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

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