GET Customer Doors

Returns a list of all doors associated with the specified customer.

Overview

This endpoint retrieves all doors that belong to a specific customer. Doors represent physical access points controlled by the VOLO system, including information about the controlling device, reader configuration, and fire alarm integration.

Resource URL

https://api.volo-access.com/v1/business/customer/{CustomerGuid}/door

Authentication

This endpoint requires both application and user authentication:

• x-nonce-token: Required
• x-app-token: Required
• x-user-credential: Required

Path Parameters

Parameter	Type	Required	Description
CustomerGuid	String	Yes	The unique identifier for the customer

Example URL

https://api.volo-access.com/v1/business/customer/550e8400-e29b-41d4-a716-446655440000/door

Response

Success Response (200 OK)

Returns a ListDoorDetailsResponse object containing an array of doors:

Parameter	Type	Description
doorDetailsResponseList	Array	Array of door objects

Each door object contains:

Parameter	Type	Description
doorGuid	String	The door unique identifier
controllerPortId	Integer	The controller port ID
name	String	The door name
deviceDetailsResponse	Object	The controlling device details
isFireAlarmExempt	Boolean	Whether the door is exempt from fire alarm
doorReaderDetailsResponse	Object	The door reader details
cameras	Array	The cameras relating to the door

The deviceDetailsResponse object contains:

Parameter	Type	Description
deviceGuid	String	The device GUID
name	String	The device name
serialNumber	String	The device serial number
activationCode	String	The activation code
notes	String	The device notes
masterSerialNumber	String	The master serial number
slave	Boolean	Whether the device is an expansion controller
master	Boolean	Whether the device is a master controller
autoReinstate	Boolean	The auto reinstate indicator
controllerLicense	String	The controller license
simLicense	String	The SIM license
customerGuid	String	The customer unique identifier
deviceId	Integer	The device ID

The doorReaderDetailsResponse object contains:

Parameter	Type	Description
readerType	String	The reader type
status	String	The reader status
deviceStatus	String	The device status
ledConfigurationCode	String	The LED configuration code
customFormatGuid	String	The custom format GUID

The cameras array contains camera objects with:

Parameter	Type	Description
cameraGuid	String	The camera unique identifier
name	String	The camera name
ipAddress	String	The camera IP address
port	Integer	The camera port
username	String	The camera username
password	String	The camera password
cameraType	String	The camera type
status	String	The camera status

Example Success Response

{
  "doorDetailsResponseList": [
    {
      "doorGuid": "456e7890-e89b-12d3-a456-426614174001",
      "controllerPortId": 1,
      "name": "Main Entrance",
      "deviceDetailsResponse": {
        "deviceGuid": "789e0123-e89b-12d3-a456-426614174002",
        "name": "Main Entrance Controller",
        "serialNumber": "VOLO001234",
        "activationCode": "ACT123456",
        "notes": "Primary access control for main building entrance",
        "masterSerialNumber": null,
        "slave": false,
        "master": true,
        "autoReinstate": true,
        "controllerLicense": "CTRL-LIC-2024-001",
        "simLicense": "SIM-LIC-2024-001",
        "customerGuid": "550e8400-e29b-41d4-a716-446655440000",
        "deviceId": 1001
      },
      "isFireAlarmExempt": false,
      "doorReaderDetailsResponse": {
        "readerType": "Proximity",
        "status": "Online",
        "deviceStatus": "Normal",
        "ledConfigurationCode": "GREEN_GRANT",
        "customFormatGuid": null
      },
      "cameras": [
        {
          "cameraGuid": "567e8901-e89b-12d3-a456-426614174007",
          "name": "Main Entrance Camera",
          "ipAddress": "192.168.1.100",
          "port": 80,
          "username": "admin",
          "password": "encrypted_password",
          "cameraType": "IP",
          "status": "Online"
        }
      ]
    },
    {
      "doorGuid": "678e9012-e89b-12d3-a456-426614174008",
      "controllerPortId": 2,
      "name": "Side Door",
      "deviceDetailsResponse": {
        "deviceGuid": "890e1234-e89b-12d3-a456-426614174003",
        "name": "Side Door Controller",
        "serialNumber": "VOLO001235",
        "activationCode": "ACT123457",
        "notes": "Expansion controller for side entrance",
        "masterSerialNumber": "VOLO001234",
        "slave": true,
        "master": false,
        "autoReinstate": true,
        "controllerLicense": "CTRL-LIC-2024-002",
        "simLicense": null,
        "customerGuid": "550e8400-e29b-41d4-a716-446655440000",
        "deviceId": 1002
      },
      "isFireAlarmExempt": true,
      "doorReaderDetailsResponse": {
        "readerType": "Keypad",
        "status": "Online",
        "deviceStatus": "Normal",
        "ledConfigurationCode": "YELLOW_READY",
        "customFormatGuid": null
      },
      "cameras": []
    }
  ]
}

Error Responses

400 Bad Request

Returned for invalid customer GUID format:

{
  "applicationMessage": "Invalid GUID format provided",
  "consumerMessage": "The customer identifier format is invalid"
}

401 Unauthorized

Returned when authentication is missing or invalid:

{
  "applicationMessage": "Missing or invalid authentication headers",
  "consumerMessage": "Authentication required"
}

403 Forbidden

Returned when user lacks permission to view the customer's doors:

{
  "applicationMessage": "User does not have permission to access customer door data",
  "consumerMessage": "You do not have permission to view this information"
}

404 Not Found

Returned when the customer doesn't exist:

{
  "applicationMessage": "Customer with GUID 550e8400-e29b-41d4-a716-446655440000 not found",
  "consumerMessage": "Customer not found"
}

500 Internal Server Error

Returned for server-side errors:

{
  "applicationMessage": "Database connection failed",
  "consumerMessage": "An error occurred while retrieving door data"
}

Example Request

GET https://api.volo-access.com/v1/business/customer/550e8400-e29b-41d4-a716-446655440000/door
x-nonce-token: MDU4ZmQ5Y2EtNTExNi00N2E0LWI0Y2EtNjM1YWRjZTZjYmNi
x-app-token: d1d0ecac-3cca-48ef-a4c3-83005c6376ca
x-user-credential: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Usage Notes

• Port Mapping: Each door is connected to a specific controller port (controllerPortId)
• Device Relationship: Doors are controlled by devices (master or expansion controllers)
• Fire Alarm Integration: Check isFireAlarmExempt to understand fire safety compliance
• Reader Types: Common reader types include Proximity, Keypad, Biometric, etc.
• Camera Integration: Doors may have associated cameras for surveillance
• Status Monitoring: Reader and device status provide real-time operational information
• LED Configuration: LED codes indicate the current state of the reader
• Empty Arrays: Some doors may not have associated cameras

Related Endpoints

• List Customer Devices - Get devices that control these doors
• Get Device Details - Get details for a specific device
• List Customer Events - Get events for these doors