GET Customer Devices

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

Overview

This endpoint retrieves all access control devices (controllers) that belong to a specific customer. This includes both master controllers and expansion controllers, providing essential information for device management and monitoring.

Resource URL

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

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/device

Response

Success Response (200 OK)

Returns a ListDeviceDetailsResponse object containing an array of devices:

Parameter	Type	Description
deviceDetailsResponseList	Array	Array of device objects

Each device 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 (for expansion controllers)
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

Example Success Response

{
  "deviceDetailsResponseList": [
    {
      "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
    },
    {
      "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
    },
    {
      "deviceGuid": "901e2345-e89b-12d3-a456-426614174004",
      "name": "Loading Bay Controller",
      "serialNumber": "VOLO001236",
      "activationCode": "ACT123458",
      "notes": "Controller for loading bay access",
      "masterSerialNumber": "VOLO001234",
      "slave": true,
      "master": false,
      "autoReinstate": false,
      "controllerLicense": "CTRL-LIC-2024-003",
      "simLicense": null,
      "customerGuid": "550e8400-e29b-41d4-a716-446655440000",
      "deviceId": 1003
    }
  ]
}

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 devices:

{
  "applicationMessage": "User does not have permission to access customer device 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 device data"
}

Example Request

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

Usage Notes

• Device Types: Devices can be either master controllers or expansion controllers (slaves)
• Master-Slave Relationship: Expansion controllers reference their master controller via masterSerialNumber
• Licenses: Each device may have controller and SIM licenses
• Auto Reinstate: This setting determines if the device automatically reinstates after certain events
• Serial Numbers: Device serial numbers are unique identifiers for hardware
• Activation Codes: Required for device activation and configuration
• Null Values: Some fields like masterSerialNumber and simLicense may be null
• Performance: This endpoint is optimized for retrieving device lists efficiently

Related Endpoints

• Get Device Details - Get detailed information about a specific device
• List Customer Doors - Get doors controlled by these devices