Developer Portal
Connector Guides
API ReferenceConsole

ARD Access Control

ARDLogo

With the ARD Access Control connector, you can link your ARD system's Doors, Access Readers, and access events (granted and denied) to the Mapped graph.

Use Cases

Potential use cases include:

  • Tracking occupancy across a building
  • Identifying hotspots for access

Configuration

This connector requires the following credentials:

CredentialDescription
Base URLThe base URL of your ARD's instance
Username & PasswordThe username and password registered with your ARD software

Mapped Concepts

Connector ConceptMapped Type
DoorsDoor
ReadersAccess Reader
Access Granted, Access Denied EventAccess Activity Status
UserIdAccess Credential Identity (anonymized)

This Access Control connector makes use of anonymization methods that allow you to identify an individual across access events while masking any personal identifiable information about that person. The JSON body of the time series event will include an anonymized identifier for the individual. The schema is illustrated below.

Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "$id": "https://schemas.mapped.com/mapped/1.0/core/Access_Activity_Status/complexValue.schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Access_Activity_Status:ComplexValueSchema",
  "type": "object",
  "properties": {
    "result": {
      "type": "string",
      "enum": [
        "denied",
        "granted"
      ]
    },
    "credentialIdentity": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "Access_Credential_Identity"
          ]
        },
        "value": {
          "type": "string"
        },
        "scope": {
          "type": "string",
          "enum": [
            "CONNECTOR"
          ]
        },
        "scopeId": {
          "type": "string"
        }
      }
    },
    "reason": {
      "type": "string"
    }
  }
}

Note: Any Access Credential Identity associated with a result has been anonymized.

Sample Code

The following example shows how to query for all Access_Activity_Status points in your org - note the value field, set to json. In the returned JSON object, you'll see "result granted" which indicates a successful badge swipe.

Request Response
Copy
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  points(filter: {exactType: {eq: "Access_Activity_Status"}}) {
    id
    name
    exactType
    series(latest: true) {
      timestamp
      value {
        json
      }
    }
  }
}