Channels
Channels were formerly known as Door Controllers - if you find an old reference (ahem!) this is what it is!
A Channel is a control point that is usually associated with some kind of electronic lock - this usually maps 1-to-1 to a reader next to a door, but might also be an elevator reader or an elevator-floor - ie something that you might want to set a permission against for a person or a group.
Channels accept a credential as a form of authorisation and, based on internal logic, open the door/lock or not.
A credential could be a proximity card (Prox, Smartcard, NFC, Oyster etc), magstripe card, barcode pin code or mobile phone.
Channels cannot be created or modified using the API at this stage
List all channels
Scopes required : account.channel.readonly
Returns a list of all Channels in your account.
GET /api/3/channels
Example Response
[
{
"id": 2060,
"name": "RC-04 demo",
"mac_address": "00:18:c8:40:09:b3",
"status": "offline",
"encryption_key": "",
"unit": 1,
"model": "RC-03-MCT-K",
"model_long": "SmartCard IP Controller",
"serial_number": "",
"card_format": "0xFFEE",
"pin_format": "",
"freescale_version": "74.08",
"pic_version": "18.00",
"reader_device_class_name": "ISO-RC-03-PRX-K",
"site_id": 330,
"updated_at": "2018-06-24T22:04:46+01:00",
"created_at": "2017-06-23T13:20:12+01:00",
"sync": {
"status": "sync_complete",
"last_sync_completed_at": "2018-06-24T18:15:52+01:00"
},
"lockdown": null,
"mode": {
"description": "normal",
"relock_at": null,
"change_stamp": "2017-06-27T11:05:17+01:00"
},
"auto_unlock": null
},
{
"id": 1059,
"name": "SJJ Desk (36:a2)",
"mac_address": "00:18:c8:00:36:a2",
"status": "offline",
"encryption_key": "",
"unit": 1,
"model": "RC-03-PRX",
"model_long": "PowerNet IP Controller",
"serial_number": "4912-34",
"card_format": "hid_10301",
"pin_format": "",
"freescale_version": "23.00",
"pic_version": "09.00",
"reader_device_class_name": "ISO-RC-03-PRX",
"site_id": 330,
"updated_at": "2017-09-26T19:32:18+01:00",
"created_at": "2013-02-19T17:57:09+00:00",
"sync": {
"status": "pending",
"last_sync_completed_at": "2014-11-06T08:31:46+00:00"
},
"lockdown": {
"message": "Cards and PINs will be rejected",
"card_lockdown": {
"state": true
},
"rex_lockdown": {
"state": false
},
"aux_lockdown": {
"state": false
}
},
"mode": {
"description": "normal",
"relock_at": null,
"change_stamp": "2016-01-29T12:42:06+00:00"
},
"auto_unlock": {
"shift_id": 503,
"name": "Fonthill test",
"updated_at": "2017-07-19T12:30:18+01:00",
"created_at": "2012-09-24T07:46:25+01:00",
"times": [
{
"day": "Tuesday",
"description": "range",
"start_time": "13:35:00 UTC",
"end_time": "13:40:00 UTC"
},
{
"day": "Sunday",
"description": "range",
"start_time": "02:00:00 UTC",
"end_time": "03:00:00 UTC"
}
]
}
},
{
"id": 1057,
"name": "Channel 2d:dc:0d",
"mac_address": "00:18:c8:2d:dc:0d",
"status": "offline",
"encryption_key": "",
"unit": 1,
"model": "RC-03-PRX-K",
"model_long": "PowerNet IP Controller",
"serial_number": "613-31",
"card_format": "",
"pin_format": "",
"freescale_version": "23.00",
"pic_version": "54.00",
"reader_device_class_name": null,
"site_id": 331,
"updated_at": "2017-09-26T19:32:18+01:00",
"created_at": "2013-02-14T14:30:39+00:00",
"sync": {
"status": "pending",
"last_sync_completed_at": "2015-06-11T08:37:24+01:00"
},
"lockdown": null,
"mode": {
"description": "normal",
"relock_at": null,
"change_stamp": "2016-06-28T07:29:13+01:00"
},
"auto_unlock": null
}
]
Remember that this endpoint might be paginated
List all channels at a specific location
You can optionally filter Channels by Site using the "site_id" field. For instance, if you wanted to return all Channels from the site_id 123, you would perform the following request:
GET /api/3/channels?site_id=123
You can obtain a list of Sites using the sites endpoint.
Retrieve a channel
Scopes required : account.channel.readonly
To obtain details for a single Channel:
GET /api/3/channel/1340
Example Response
{
"id": 1340,
"name": "Art School",
"mac_address": "00:10:20:30:40:50",
"encryption_key": "",
"unit": 1,
"model": "IPBR-2",
"serial_number": "",
"card_format": "",
"pin_format": "",
"freescale_version": "6.00",
"pic_version": "53.00",
"site_id": 330,
"updated_at": "2015-07-07T13:18:38+01:00",
"created_at": "2013-10-21T21:18:17+01:00",
"sync": {
"status": "ok",
"last_sync_completed_at": "2015-03-05T20:40:25+00:00"
},
"auto_unlock": {
"shift_id": 549,
"name": "Membership Access",
"times": [
{
"day": "Monday",
"description": "range",
"shift_time": "5:00-22:00"
},
{
"day": "Wednesday",
"description": "range",
"shift_time": "5:00-22:00"
},
{
"day": "Friday",
"description": "range",
"shift_time": "5:00-22:00"
}
]
}
}