Openpath orgs/thirdPartyWiegands API
The orgs/thirdPartyWiegands API from Openpath — 2 operation(s) for orgs/thirdpartywiegands.
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth orgs/thirdPartyWiegands API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: orgs/thirdPartyWiegands
paths:
/orgs/{orgId}/thirdPartyWiegands:
get:
summary: List all third party wiegand readers
operationId: listThirdPartyWiegands
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o{params.orgId}-quickStart:w,o{params.orgId}-quickStart:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listThirdPartyWiegands'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
minimum: 1
maximum: 1000
name: limit
in: query
- type: integer
default: 0
minimum: 0
name: offset
in: query
- type: string
default: name
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
name: sort
in: query
- type: string
default: asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
name: order
in: query
- type: string
name: q
in: query
- type: string
name: filter
in: query
- type: string
name: preFilter
in: query
consumes:
- application/json
produces:
- application/json
tags:
- orgs/thirdPartyWiegands
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
acuPort:
x-nullable: true
type: object
properties:
id:
type: integer
acuPortTypePortNumber:
type: number
virtualPortNumber:
type: number
x-nullable: true
portNumber:
type: number
x-nullable: true
label:
type: string
acu:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
expansionBoard:
type: object
properties:
id:
type: integer
number:
type: integer
required:
- id
eol:
x-nullable: true
type: object
properties:
eolSupervision:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
required:
- id
entries:
type: array
items:
type: object
properties:
id:
type: integer
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}-hw:w
- o{params.orgId}-hw:r
- o{params.orgId}-site:w
- o{params.orgId}-site:r
- o{params.orgId}-siteGeneral:w
- o{params.orgId}-siteGeneral:r
- o{params.orgId}-admin:w
- o{params.orgId}-admin:r
- o{params.orgId}-quickStart:w
- o{params.orgId}-quickStart:r
- o:w
- o:r
- s-o:w
- s-o:r
/orgs/{orgId}/thirdPartyWiegands/{thirdPartyWiegandId}:
get:
summary: Describe a third party wiegand reader
operationId: describeThirdPartyWiegand
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-siteGeneral:w,o{params.orgId}-siteGeneral:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeThirdPartyWiegand'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: thirdPartyWiegandId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/thirdPartyWiegands
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: integer
name:
type: string
acuPort:
x-nullable: true
type: object
properties:
id:
type: integer
acuPortTypePortNumber:
type: number
virtualPortNumber:
type: number
x-nullable: true
portNumber:
type: number
x-nullable: true
label:
type: string
acu:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
expansionBoard:
type: object
properties:
id:
type: integer
number:
type: integer
required:
- id
eol:
x-nullable: true
type: object
properties:
eolSupervision:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
required:
- id
entries:
type: array
items:
type: object
properties:
id:
type: integer
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}-hw:w
- o{params.orgId}-hw:r
- o{params.orgId}-site:w
- o{params.orgId}-site:r
- o{params.orgId}-siteGeneral:w
- o{params.orgId}-siteGeneral:r
- o:w
- o:r
- s-o:w
- s-o:r
patch:
summary: Update a third party wiegand reader
operationId: updateThirdPartyWiegand
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-hw:w,o{params.orgId}-site:w,o{params.orgId}-siteGeneral:w,o{params.orgId}-admin:w,o{params.orgId}-quickStart:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateThirdPartyWiegand'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: thirdPartyWiegandId
in: path
required: true
- in: body
name: body
schema:
type: object
properties:
name:
type: string
minLength: 1
maxLength: 100
x-convert:
trim: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/thirdPartyWiegands
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-hw:w
- o{params.orgId}-site:w
- o{params.orgId}-siteGeneral:w
- o{params.orgId}-admin:w
- o{params.orgId}-quickStart:w
- o:w
- s-o:w
securityDefinitions:
jwt:
type: apiKey
name: Authorization
in: header
x-proxy-enabled: false