GET Device

Returns the details of a specific device for the customer.

Overview

This endpoint retrieves detailed information about a specific access control device within a customer's system. This is useful for getting complete device information after identifying a device from the list endpoint.

Resource URL

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

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
DeviceGuid	String	Yes	The unique identifier for the device

Example URL

https://api.volo-access.com/v1/business/customer/550e8400-e29b-41d4-a716-446655440000/device/789e0123-e89b-12d3-a456-426614174002

Response

Success Response (200 OK)

Returns a DeviceDetailsResponse object with detailed device information:

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

{
  "deviceGuid": "789e0123-e89b-12d3-a456-426614174002",
  "name": "Main Entrance Controller",
  "serialNumber": "VOLO001234",
  "activationCode": "ACT123456",
  "notes": "Primary access control for main building entrance. Installed on 2024-01-15. Handles main lobby, reception area, and elevator access. Configured with fire alarm integration and emergency override capabilities.",
  "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
}

Error Responses

400 Bad Request

Returned for invalid GUID format:

{
  "applicationMessage": "Invalid GUID format provided",
  "consumerMessage": "The device or 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 device details:

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

404 Not Found

Returned when the customer or device doesn't exist:

{
  "applicationMessage": "Device with GUID 789e0123-e89b-12d3-a456-426614174002 not found",
  "consumerMessage": "Device 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/789e0123-e89b-12d3-a456-426614174002
x-nonce-token: MDU4ZmQ5Y2EtNTExNi00N2E0LWI0Y2EtNjM1YWRjZTZjYmNi
x-app-token: d1d0ecac-3cca-48ef-a4c3-83005c6376ca
x-user-credential: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Usage Notes

• GUID Format: Both customer and device GUIDs follow the standard UUID format
• Permissions: Users can only access device data they have permission to view
• Performance: This endpoint is optimized for quick retrieval of individual device data
• Null Values: Some fields like masterSerialNumber and simLicense may be null
• Device Types: Check the master and slave fields to understand the device's role
• Licenses: Controller and SIM licenses are essential for device operation
• Activation Codes: Required for device configuration and activation
• Auto Reinstate: Determines if the device automatically recovers from certain states

Related Endpoints

• List Customer Devices - Get all devices for a customer
• List Customer Doors - Get doors controlled by this device