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"
}
'import requests
url = "https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig"
payload = { "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA" }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({ownerDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA'})
};
fetch('https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ownerDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n}")
.asString();{
"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,
"disableQrScanner": true,
"disableWaveToUnlock": true,
"disposition": "INGRESS",
"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
},
"supportedAperioLockModels": [
"IN100_V3_MC"
],
"supportedSchlageApmFamilies": [
"AD_WIRED"
]
}Get or create device physical port config
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"
}
'import requests
url = "https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig"
payload = { "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA" }
headers = {
"x-auth-scheme": "<x-auth-scheme>",
"x-auth-apikey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-auth-scheme': '<x-auth-scheme>',
'x-auth-apikey': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({ownerDeviceUuid: 'AAAAAAAAAAAAAAAAAAAAAA'})
};
fetch('https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api2.rhombussystems.com/api/component/getOrCreateDevicePhysicalPortConfig")
.header("x-auth-scheme", "<x-auth-scheme>")
.header("x-auth-apikey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ownerDeviceUuid\": \"AAAAAAAAAAAAAAAAAAAAAA\"\n}")
.asString();{
"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,
"disableQrScanner": true,
"disableWaveToUnlock": true,
"disposition": "INGRESS",
"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
},
"supportedAperioLockModels": [
"IN100_V3_MC"
],
"supportedSchlageApmFamilies": [
"AD_WIRED"
]
}Authorizations
Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).
Headers
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 Body
base 64 (url-safe) uuid string
"AAAAAAAAAAAAAAAAAAAAAA"
Response
OK
Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
Show child attributes
Show child attributes
Show child attributes
Show child attributes
What kind of lock this is. Stated because the protocol does not report it: Device Info gives a product class, which says what a device does rather than which model it is. A model the controller cannot drive is refused - it has to be V3 hardware, which is the only generation that reports a door mode, and it has to lock something.
C100_V3, E100_V3, L100_V3, H100_V3, AU100_V3, IN100_V3_MC, G100_V3, KL100_V3, K100_V3_MC, KS100_V3_MC, ES100_V3_MC, DL100_V3_MC, DR100_V3_MC, R100_V3_MC, C100, C100_V2SE, E100, E100_V2SE, L100, PROFILE_N2_MORTISE, INCEPTA, A100, K100, K100DI, KS100, M100, R100 Which family of Schlage lock this is. Stated because the protocol cannot be asked: the OEM code reply has no address in it, so a reply cannot be attributed to one lock. It decides how the lock's status bits are read.
AD_WIRED, AD_WIRELESS, ENGAGE, RMRU