curl --request POST \
--url https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'{
"detectedInvalidPortConfigs": [
{
"boardNum": 123,
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"portNum": 123,
"reason": "NON_EXISTANT_COMPONENT_BOARD_NUM"
}
],
"deviceComponents": [
{
"allowCredsDuringUnlock": true,
"baseType": "reader",
"createdAtMillis": 123,
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"disableCardReader": true,
"disableKeypad": true,
"disableWaveToUnlock": true,
"hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"osdpAddress": 123,
"otherReaderUnlockAudioFeedbackEnabled": true,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerHardwareType": "RASPBERRY_PI_3",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"portImmutable": true,
"readerType": "wiegand",
"remoteUnlockAudioFeedbackEnabled": true,
"serialNumber": "<string>",
"type": "RhombusOsdpDoorReader",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"devicePhysicalPortConfig": {
"boardMap": {},
"createdAtMillis": 123,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"updatedAtMillis": 123
}
}Gets a physical port layout for the specified device, components owned by that device and details about the port configuration validity. Map is instantiated if it doesn’t currently exist as part of the call.
curl --request POST \
--url https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig \
--header 'Content-Type: application/json' \
--header 'x-auth-apikey: <api-key>' \
--header 'x-auth-scheme: <x-auth-scheme>' \
--data '
{
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'{
"detectedInvalidPortConfigs": [
{
"boardNum": 123,
"componentUuids": [
"AAAAAAAAAAAAAAAAAAAAAA"
],
"portNum": 123,
"reason": "NON_EXISTANT_COMPONENT_BOARD_NUM"
}
],
"deviceComponents": [
{
"allowCredsDuringUnlock": true,
"baseType": "reader",
"createdAtMillis": 123,
"deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"disableCardReader": true,
"disableKeypad": true,
"disableWaveToUnlock": true,
"hardwareUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"name": "<string>",
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"osdpAddress": 123,
"otherReaderUnlockAudioFeedbackEnabled": true,
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerHardwareType": "RASPBERRY_PI_3",
"port": {
"boardNum": 123,
"portNum": 123,
"portType": "RS485"
},
"portImmutable": true,
"readerType": "wiegand",
"remoteUnlockAudioFeedbackEnabled": true,
"serialNumber": "<string>",
"type": "RhombusOsdpDoorReader",
"updatedAtMillis": 123,
"uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
],
"devicePhysicalPortConfig": {
"boardMap": {},
"createdAtMillis": 123,
"orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
"updatedAtMillis": 123
}
}Documentation Index
Fetch the complete documentation index at: https://api-docs.rhombus.community/llms.txt
Use this file to discover all available pages before exploring further.
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
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.
api-token, api, partner-api-token, partner-api base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
OK
Was this page helpful?