Openpath orgs/wirelessLockProviders API
The orgs/wirelessLockProviders API from Openpath — 6 operation(s) for orgs/wirelesslockproviders.
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth orgs/wirelessLockProviders API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: orgs/wirelessLockProviders
paths:
/orgs/{orgId}/wirelessLockProviders:
get:
summary: List all wireless lock providers
operationId: listWirelessLockProviders
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessLockProviders'
parameters:
- type: integer
name: orgId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/wirelessLockProviders
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: number
siteIdExt:
type: string
x-nullable: true
siteAuthKey:
type: string
x-nullable: true
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
orgId:
type: number
wirelessLockProviderType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
x-op-scopes:
- o{params.orgId}-integrations:r
- o{params.orgId}-hw:w
- o{params.orgId}-hw:r
- o:r
- s-o:r
post:
summary: Create a wireless lock provider
operationId: createWirelessLockProvider
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o:w,s-o:w<br/><br/>__Endpoint name__: createWirelessLockProvider'
parameters:
- type: integer
name: orgId
in: path
required: true
- in: body
name: body
schema:
type: object
properties:
siteIdExt:
type: string
x-nullable: true
siteAuthKey:
type: string
x-nullable: true
wirelessLockProviderTypeId:
type: integer
required:
- wirelessLockProviderTypeId
consumes:
- application/json
produces:
- application/json
tags:
- orgs/wirelessLockProviders
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
siteIdExt:
type: string
x-nullable: true
siteAuthKey:
type: string
x-nullable: true
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
orgId:
type: number
wirelessLockProviderType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
x-op-scopes:
- o{params.orgId}-integrations:w
- o:w
- s-o:w
/orgs/{orgId}/wirelessLockProviders/{wirelessLockProviderId}:
get:
summary: Describe a wireless lock provider
operationId: describeWirelessLockProvider
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:r,s-o:r<br/><br/>__Endpoint name__: describeWirelessLockProvider'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: wirelessLockProviderId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/wirelessLockProviders
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
siteIdExt:
type: string
x-nullable: true
siteAuthKey:
type: string
x-nullable: true
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
orgId:
type: number
wirelessLockProviderType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
x-op-scopes:
- o{params.orgId}-integrations:r
- o{params.orgId}-hw:w
- o{params.orgId}-hw:r
- o:r
- s-o:r
delete:
summary: Remove a wireless lock provider and all related devices
operationId: deleteWirelessLockProvider
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteWirelessLockProvider'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: wirelessLockProviderId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/wirelessLockProviders
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-integrations:w
- o:w
- s-o:w
/orgs/{orgId}/wirelessLockProviders/{wirelessLockProviderId}/operators:
get:
summary: List all operators for a wireless lock provider
operationId: listWirelessLockProviderOperators
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessLockProviderOperators'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: wirelessLockProviderId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/wirelessLockProviders
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
userName:
type: string
role:
type: string
firstName:
type: string
lastName:
type: string
operatorId:
type: integer
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
x-op-scopes:
- o{params.orgId}-integrations:r
- o{params.orgId}-hw:w
- o{params.orgId}-hw:r
- o:r
- s-o:r
/orgs/{orgId}/wirelessLockProviders/{wirelessLockProviderId}/firmwares:
get:
summary: List all firmwares available for a wireless lock provider by device
operationId: listWirelessLockProviderFirmwares
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o:r,s-o:r<br/><br/>__Endpoint name__: listWirelessLockProviderFirmwares'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: wirelessLockProviderId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/wirelessLockProviders
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
manufacturer:
type: string
model:
type: string
versions:
type: array
items:
type: object
properties:
name:
type: string
description:
type: string
version:
type: string
extendedVersion:
type: string
x-nullable: true
isPublic:
type: boolean
default: false
releaseDate:
type: string
format: date
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
x-op-scopes:
- o{params.orgId}-integrations:r
- o{params.orgId}-hw:w
- o{params.orgId}-hw:r
- o:r
- s-o:r
/orgs/{orgId}/wirelessLockProviders/{wirelessLockProviderId}/syncDevices:
post:
summary: Sync devices for a wireless lock provider
operationId: syncWirelessLockProviderDevices
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: syncWirelessLockProviderDevices'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: wirelessLockProviderId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/wirelessLockProviders
security:
- jwt: []
responses:
'201':
description: Sync initiated
x-op-scopes:
- o{params.orgId}-integrations:w
- o{params.orgId}-hw:w
- o:w
- s-o:w
/orgs/{orgId}/wirelessLockProviders/{wirelessLockProviderId}/invite:
post:
summary: Invite self to be a site operator for a wireless lock provider
operationId: inviteWirelessLockProviderOperator
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-integrations:w,o{params.orgId}-hw:w,o:w,s-o:w<br/><br/>__Endpoint name__: inviteWirelessLockProviderOperator'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: wirelessLockProviderId
in: path
required: true
- x-nullable: true
in: body
name: body
schema:
type: object
properties:
email:
type: string
x-format:
email: true
x-convert:
trim: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/wirelessLockProviders
security:
- jwt: []
responses:
'201':
description: Created
x-op-scopes:
- o{params.orgId}-integrations:w
- o{params.orgId}-hw:w
- o:w
- s-o:w
securityDefinitions:
jwt:
type: apiKey
name: Authorization
in: header
x-proxy-enabled: false