License Webservice

Get pane license status

Whether this organization is currently licensed to use a PANE app. Any member of the organization may ask; the PANE gateway asks on the visitor's behalf before serving the pane.

post/api/license/getPaneLicenseStatus

Request

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

paneIdstring nullable

Id of the pane (the id in the pane's hostname, <paneId>.pane.rhombus.com)

Response

OK

assignableboolean nullable

True when Rhombus has made the pane available to the organization, licensed or not

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
gracePeriodEndDatestring date-time nullable

When the current entitlement lapses; absent for a license granted without a term

licenseUuidstring RUUID nullable

base 64 (url-safe) uuid string

licensedboolean nullable

True when an active pane license is assigned to the pane

reason'LICENSED' | 'NO_LICENSE' | 'EXPIRED' | 'INVALID_STATE'

LICENSED, or why the pane is not licensed: NO_LICENSE, EXPIRED, INVALID_STATE

warningMsgstring nullable

Example response

{
  "licenseUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Changes

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