{
"opencollection": "1.0.0",
"info": {
"name": "Openpath API Documentation auth orgs/wirelessLocks API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "orgs/wirelessLocks",
"type": "folder"
},
"items": [
{
"info": {
"name": "List all wireless locks",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/wirelessLocks",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-site:r,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashEntry:w,o{params.orgId}-dashEntry:r,o{params.orgId}-dashActivity:w,o{params.orgId}-dashActivity:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:r,s-o:r
__Endpoint name__: listWirelessL"
},
{
"info": {
"name": "Create a wireless lock ",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/wirelessLocks",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: createWirelessLock"
},
{
"info": {
"name": "Describe a wireless lock ",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/wirelessLocks/:wirelessLockId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "wirelessLockId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r
__Endpoint name__: describeWirelessLock"
},
{
"info": {
"name": "Update a wireless lock ",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/orgs/:orgId/wirelessLocks/:wirelessLockId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "wirelessLockId",
"value": "",
"type": "path"
},
{
"name": "ignoreHooks",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: updateWirelessLock"
},
{
"info": {
"name": "Remove a wireless lock ",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/wirelessLocks/:wirelessLockId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "wirelessLockId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: deleteWirelessLock"
},
{
"info": {
"name": "Update the firmware for multiple wireless locks to the latest version",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/wirelessLocks/updateFirmwareBatch",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "wirelessLockIds",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: updateWirelessLockFirmwareBatch"
},
{
"info": {
"name": "Blink the reader or inside-push-button LED for a wireless lock to identify it.",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/wirelessLocks/:wirelessLockId/blinkLed",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "wirelessLockId",
"value": "",
"type": "path"
},
{
"name": "ledName",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: blinkWirelessLockLed"
},
{
"info": {
"name": "Update the firmware for a wireless lock to a specific version",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/wirelessLocks/:wirelessLockId/updateFirmware",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "wirelessLockId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-site:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o{params.orgId}-siteGeneral:w,o:w,s-o:w
__Endpoint name__: updateWirelessLockFirmware"
}
]
}
],
"bundled": true
}