Org Webservice

Get organization details V2

Get details about organization

post/api/org/getOrgV2

Request

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

OrgGetOrgV2WSRequest required

Request object for getting organization details V2.

Response

OK

cameraConfigDefaultsobject nullable

Map of hardware variations to default video configurations

cameraConfigOptionsobject nullable

Map of hardware variations to available video configuration options

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

Map of feature flags for the organization

managingPartnerNamestring nullable

MSP initiative: name of the MSP that manages this org (org.managingPartnerOrgUuid), when managed.

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.