Component Webservice

Create an access controlled door

Create an access controlled door

post/api/component/createAccessControlledDoor

Request

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

accessControlledDoorLabelsstring[] nullable

Example request

{
  "accessControlledDoor": {
    "apbZoneId": "AAAAAAAAAAAAAAAAAAAAAA",
    "aperioDoorExtensionComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "aperioGatewayComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "associatedCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "associatedFaceDetectionCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "buttonComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "defaultAccessStateOriginator": {
      "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "doorAuthFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    },
    "doorScheduleFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    },
    "doorStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    },
    "dpiComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "readerComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "relayComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "rexComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "schlageDoorExtensionComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "schlageGatewayComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "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

Example response

{
  "accessControlledDoor": {
    "apbZoneId": "AAAAAAAAAAAAAAAAAAAAAA",
    "aperioDoorExtensionComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "aperioGatewayComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "associatedCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "associatedFaceDetectionCameras": [
      "AAAAAAAAAAAAAAAAAAAAAA.v0"
    ],
    "buttonComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "defaultAccessStateOriginator": {
      "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "doorAuthFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    },
    "doorScheduleFirstInStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    },
    "doorStateOverride": {
      "originator": {
        "grantedToInternalEntityUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "supportAuthorityUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    },
    "dpiComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "readerComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "relayComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "rexComponents": [
      {
        "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "schlageDoorExtensionComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "schlageGatewayComponent": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
    },
    "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

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