6.1 HTTP API verze 3

{ "openapi": "3.0.1", "info": { "title": "2N Access Commander API", "description": "## Important note\r\n\r\nThis documentation file purpose is to help Access Commander development team\r\nas a reference manual. This file **IS NOT the official Access Commander API\r\nreference manual** and might NOT always reflect the actual version of the\r\nAPI endpoints. If you find any bug please report it to your distributor and\r\nhe will schedule a fix into future releases.\r\n\r\n\r\n## Address\r\n\r\n\r\nThe URL of AccessCommander's API is versioned and uses https, i.e. the url\r\nlooks like `https://serveraddress/api/v3/...`, where:\r\n\r\n\r\n`serveraddress` is hostname of AC, \r\n\r\n\r\n## HTTP\r\n\r\n\r\nHttp commands used for communication with the server:\r\n\r\n\r\n`GET` lists entities (getting the list of entities with parameter values) or get single entity\r\n\r\n\r\n`PUT` updates the whole entity\r\n\r\n\r\n`POST` creates a new entity\r\n\r\n\r\n`DELETE` deletes the entity\r\n\r\n\r\n`PATCH` updates entity according to JSON PATCH RFC 6902\r\n\r\n\r\n## Data Structure\r\n\r\n\r\n### Server Response\r\n\r\n\r\nResponse structure:\r\n\r\n\r\n```json\r\n\r\n{\r\n \"Id\": ...\r\n}\r\n\r\n```\r\n\r\n\r\n### Errors\r\n\r\n`401` unauthorized\r\n\r\n\r\n`501` server errors, the structure looks like this:\r\n\r\n\r\n```json\r\n\r\n{\r\n \"Code\": 2,\r\n \"Message\": \"...\",\r\n \"Detail\": \"...\"\r\n}\r\n\r\n```\r\n\r\n## Authentication\r\n\r\n\r\nThe user sends a request containing username and password to the endpoint\r\n`/login`.\r\n\r\nIf the pair is valid, the server creates the cookie and sends it back to the\r\nbrowser.\r\n\r\nAll consequent requests are sent to the server along with the cookie. The\r\nserver always verifies\r\n\r\nif the cookie is valid. If it is not, it returns 401 in response. The cookie\r\nis deleted by sending \r\n\r\nrequest to the endpoint `/logout`.", "version": "v3" }, "paths": { "/api/v3/AccessRules": { "get": { "tags": [ "AccessRules", "UserManager", "Admin", "AccessManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRuleQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32AccessRuleBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32PatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/AccessRules/bulk": { "post": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "description": "Create bulk access rules for each of input combination (the Cartesian product of given groups and roles).", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkAccessRulesDto" } } } }, "responses": { "200": { "description": "The list of access rules", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRule" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/AccessRules/{id}": { "get": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/AccessRules/{accessRuleId}": { "patch": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "parameters": [ { "name": "accessRuleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRule" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Areas": { "get": { "tags": [ "Areas", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Areas", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaBase" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Area" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Areas", "Admin" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32AreaBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32PatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Areas/{id}": { "get": { "tags": [ "Areas", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Area" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Areas", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaBase" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Area" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Areas", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Area" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Areas", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Areas/settings": { "get": { "tags": [ "Areas", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Areas", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Areas", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Areas/{id}/antipassback/blocked": { "delete": { "tags": [ "Areas", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Attendance/{userId}": { "get": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceReport" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Attendance/{userId}/{year}/{month}": { "get": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "year", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceReport" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Attendance/{userId}/intervals": { "post": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkInterval" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkInterval" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Attendance/{userId}/intervals/{intervalId}": { "put": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "intervalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkInterval" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkInterval" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "intervalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkInterval" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Attendance/{userId}/{year}/{month}/report.csv": { "get": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "year", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Attendance/{userId}/{year}/{month}/report.pdf": { "get": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "year", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Attendance/{year}/{month}/report.pdf": { "get": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "parameters": [ { "name": "year", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "userIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Attendance/report.csv": { "get": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "parameters": [ { "name": "userIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/system/backup/run": { "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/system/backup/storage": { "get": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupStorageSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupStorageSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupStorageSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/system/backup/periodic": { "get": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeriodicBackupSetting" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeriodicBackupSetting" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeriodicBackupSetting" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/system/restore/fileUpload": { "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupInfo" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/system/restore": { "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreRequest" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/system/backup/files": { "get": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupFileList" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupInfo" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/system/backup/files/download/{location}/{fileName}": { "get": { "tags": [ "BackupAndRestore", "Admin" ], "parameters": [ { "name": "location", "in": "path", "required": true, "schema": { "enum": [ "Local", "Smb", "Upload" ], "type": "string" } }, { "name": "fileName", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/system/import": { "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportRequest" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/CamLogs": { "get": { "tags": [ "CamLogs", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLogQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "CamLogs", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLog" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLog" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "CamLogs", "Admin", "UserManager", "VisitorManager" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32CamLogBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32PatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/CamLogs/{id}": { "get": { "tags": [ "CamLogs", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLog" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "CamLogs", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLog" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLog" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "CamLogs", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLog" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "CamLogs", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/CamLogs/eventtypes": { "get": { "tags": [ "CamLogs", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "enum": [ "KeyPressed", "CallStateChanged", "CodeEntered", "CardEntered", "DeviceState", "KeyReleased", "InputChanged", "OutputChanged", "AudioLoopTest", "MotionDetected", "RegistrationStateChanged", "SwitchStateChanged", "NoiseDetected", "TamperSwitchActivated", "UnauthorizedDoorOpen", "DoorOpenTooLong", "LoginBlocked", "PairingStateChanged", "UserAuthenticated", "RemoteDoorOpen", "MobKeyEntered", "FingerEntered", "UserRejected", "CardHeld", "AccessLimited", "SilentAlarm", "RexActivated", "AccessTaken", "HardwareChanged", "DirectorySaved", "DoorStateChanged", "DtmfEntered", "LiftStatusChanged", "LiftFloorsEnabled", "LiftConfigChanged", "SwitchesBlocked", "LicensePlateRecognized", "ConfigurationChanged", "SwitchOperationChanged", "AccessBlocked" ], "type": "string" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies": { "get": { "tags": [ "Companies", "Admin", "DoorManager", "AccessManager", "UserManager", "VisitorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Companies", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Companies", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32CompanyBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32PatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}": { "get": { "tags": [ "Companies", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Companies", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Companies", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/devices": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "onlyPairingDevices", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/defaultEmailSettings": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/emailSettings": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/emailTest": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTest" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/importUsers": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/importUsers/{deviceId}": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/ldap": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettings" } } } }, "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/ldap/synchronizedFields": { "get": { "tags": [ "Companies", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapFields" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/ldap/synchronize": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/ldap/test": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettings" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/visitorManagerGroups": { "get": { "tags": [ "Companies", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Companies/{id}/zones": { "get": { "tags": [ "Companies", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/DeviceFirmware": { "get": { "tags": [ "DeviceFirmware", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FirmwareDeploymentStatus" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/DeviceFirmware/enabled": { "get": { "tags": [ "DeviceFirmware", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "DeviceFirmware", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/DeviceFirmware/{firmwareId}/target/fileUpload": { "put": { "tags": [ "DeviceFirmware", "Admin" ], "parameters": [ { "name": "firmwareId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmwareDeploymentStatus" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/DeviceFirmware/{firmwareId}/target": { "put": { "tags": [ "DeviceFirmware", "Admin" ], "parameters": [ { "name": "firmwareId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmwareDeploymentStatus" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "DeviceFirmware", "Admin" ], "parameters": [ { "name": "firmwareId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmwareDeploymentStatus" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/DeviceFirmware/{firmwareId}/devicetest": { "put": { "tags": [ "DeviceFirmware", "Admin" ], "parameters": [ { "name": "firmwareId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/DeviceFirmware/{firmwareId}/releasenotes": { "get": { "tags": [ "DeviceFirmware", "Admin" ], "parameters": [ { "name": "firmwareId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseNotes" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/DeviceFirmware/incompatibleVersions": { "get": { "tags": [ "DeviceFirmware", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncompatibleFirmwareQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "DeviceFirmware", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncompatibleFirmware" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncompatibleFirmwareQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/DeviceFirmware/compatibleVersions": { "get": { "tags": [ "DeviceFirmware", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncompatibleFirmwareQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices": { "get": { "tags": [ "Devices", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Devices", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceBase" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Devices", "Admin" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32DeviceBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32PatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceBase" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/discover": { "get": { "tags": [ "Devices", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/remove/{deleteAction}": { "delete": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deleteAction", "in": "path", "required": true, "schema": { "enum": [ "None", "ClearDirectory", "FactoryReset" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceBase" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/phonebook": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Phonebook" } } } }, "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/phonebook/view": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/backup": { "put": { "tags": [ "Devices", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/backups": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceBackup" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/backup": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/backup/download": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "text/xml": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/restore": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatus" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/restore/{backupId}": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "backupId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatus" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/password": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/password/generate": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/replace": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/switches/{switchId}": { "put": { "tags": [ "Devices", "Admin", "DoorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "switchId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "enum": [ "On", "Off", "Trigger", "Lock", "Unlock", "Hold", "Release" ], "type": "string" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/holdopen": { "put": { "tags": [ "Devices", "Admin", "DoorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/floors/{floorId}": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "floorId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiftFloor" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiftFloor" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/firmware/applyTargetVersion": { "put": { "tags": [ "Devices", "Admin" ], "description": "Upgrades device firmware to version specified in the system.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The device upgrade has started successfully" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/firmware": { "put": { "tags": [ "Devices", "Admin" ], "description": "Uploads user provided firmware file to device.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "204": { "description": "Uploads and applies provided firmware package" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/{id}/snapshots/{timestamp}": { "get": { "tags": [ "Devices", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "timestamp", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/certificatesValidation": { "get": { "tags": [ "Devices", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "enum": [ "none", "chain", "fingerprint" ], "type": "string" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Devices", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "enum": [ "none", "chain", "fingerprint" ], "type": "string" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Devices/ntpmode": { "get": { "tags": [ "Devices", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "enum": [ "None", "PushServers", "PushLocalServer" ], "type": "string" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Devices", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "enum": [ "None", "PushServers", "PushLocalServer" ], "type": "string" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Groups": { "get": { "tags": [ "Groups", "UserManager", "VisitorManager", "AttendanceManager", "Admin", "AccessManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Groups", "Admin", "AccessManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Groups", "Admin", "AccessManager" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidGroupBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidPatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Groups/{id}": { "get": { "tags": [ "Groups", "UserManager", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Groups", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Groups", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Groups", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Groups/{id}/members": { "put": { "tags": [ "Groups", "UserManager", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Groups", "UserManager", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "get": { "tags": [ "Groups", "UserManager", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Lockdown/activate": { "put": { "tags": [ "Lockdown", "Admin", "DoorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LockdownRequest" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Lockdown/deactivate": { "put": { "tags": [ "Lockdown", "Admin", "DoorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LockdownRequest" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/login": { "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginData" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/logout": { "put": { "tags": [ "Login" ], "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/password/reset": { "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "maxLength": 64, "type": "string" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/password/verifyResetToken": { "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "maxLength": 16, "type": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/password/set": { "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordSetRequest" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/captcha/image": { "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "image/png": { "schema": { "type": "string", "format": "byte" } }, "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/captcha/verify": { "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptchaVerification" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Logs/access": { "get": { "tags": [ "Logs", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessEventDataQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Logs/access/export.csv": { "get": { "tags": [ "Logs", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Logs/system": { "get": { "tags": [ "Logs", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemLogDataQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Logs/system/export.csv": { "get": { "tags": [ "Logs", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Notifications": { "get": { "tags": [ "Notifications", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Notifications", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Notifications", "Admin" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32NotificationBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32PatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Notifications/clearAppBar": { "put": { "tags": [ "Notifications", "Admin" ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Notifications/{id}": { "get": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notification" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Presence/timeout": { "get": { "tags": [ "Presence", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Presence", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "maximum": 24, "minimum": 1, "type": "integer", "format": "int32" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Presence": { "get": { "tags": [ "Presence" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PresentPerson" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Reports/available": { "get": { "tags": [ "Reports" ], "summary": "Return if at least one report is available in system", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Reports": { "get": { "tags": [ "Reports", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "summary": "Return list of all available reports", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportInfo" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportInfo" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReportInfo" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Reports/{id}.csv": { "get": { "tags": [ "Reports", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "summary": "Download report as CSV file", "parameters": [ { "name": "id", "in": "path", "description": "Report ID", "required": true, "schema": { "pattern": "^[A-Za-z0-9\\-_]+$", "type": "string" } }, { "name": "_delimiter", "in": "query", "description": "Delimiter character between fields (default value is comma)", "schema": { "type": "string" } }, { "name": "_nomultiline", "in": "query", "description": "Indicate if new line in multiline values should be removed (default is to allow multiline values)", "schema": { "type": "boolean" } }, { "name": "_nobom", "in": "query", "description": "Indicate if UTF-8 BOM (Byte Order Mark) should be removed (by default BOM is included)", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Success" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Search": { "get": { "tags": [ "Search" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResults" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Search/suggestions": { "get": { "tags": [ "Search" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 3 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResults" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Search/suggestions/accesslog": { "get": { "tags": [ "Search" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResults" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Search/suggestions/systemlog": { "get": { "tags": [ "Search" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResults" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Search/suggestions/lockdown": { "get": { "tags": [ "Search" ], "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" } }, { "name": "addedDevices", "in": "query", "description": "comma separated Ids of added devices", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResults" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/accessPointsEnabled": { "get": { "tags": [ "Settings", "Admin", "AccessManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/attendance/mode": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "enum": [ "Free", "InOut", "InOutOnSelectedDevices" ], "type": "string" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "enum": [ "Free", "InOut", "InOutOnSelectedDevices" ], "type": "string" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/attendance/devices": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/collectStatistics": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/datetime": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateAndTimeSetting" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateAndTimeSetting" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/datetime/timezone": { "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateAndTimeSetting" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/datetime/timezones": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/logLifespan": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiskManagementSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiskManagementSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiskManagementSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/mobilekey/keys": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MobileKeyKeyInfo" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MobileKeyKeyInfo" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/mobilekey/locationData": { "get": { "tags": [ "Settings", "Admin", "UserManager", "VisitorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileKeyLocationData" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/mobilekey/keys/{ordinal}": { "delete": { "tags": [ "Settings", "Admin" ], "parameters": [ { "name": "ordinal", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MobileKeyKeyInfo" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/network": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/network/proxy": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxySetting" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxySetting" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxySetting" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/readers": { "get": { "tags": [ "Settings" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReaderSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReaderSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReaderSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/securecards": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecureCardKeyInfo" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecureCardKeysImport" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Settings", "Admin" ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/serverAddress": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string", "format": "uri" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "string", "format": "uri" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/smtp": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmtpSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmtpSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmtpSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/smtp/sendtestemail": { "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTest" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/smtp/enabled": { "get": { "tags": [ "Settings", "Admin", "UserManager", "VisitorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/ssh": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/ssh/password": { "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChange" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Settings/visitorRetention": { "get": { "tags": [ "Settings", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Settings", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "maximum": 365, "minimum": 0, "type": "integer", "format": "int32" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/SignalR/topics": { "get": { "tags": [ "SignalR" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TopicDescription" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/diagnostics/package/status": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatus" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/diagnostics/package/create": { "put": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatus" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/diagnostics/package/download": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/diskUsage": { "get": { "tags": [ "System", "Admin" ], "parameters": [ { "name": "days", "in": "query", "schema": { "type": "integer", "format": "int32", "default": 356 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiskUsageReport" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/entityCounts": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCounts" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/eula": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "boolean" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/license": { "get": { "tags": [ "System", "Admin", "UserManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseInfo" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/license/import.xml": { "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseInfo" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/license/activatebasic": { "put": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseInfo" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/license/renew": { "put": { "tags": [ "System", "Admin" ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/time": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemTime" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/update/settings": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcomUpdateSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcomUpdateSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcomUpdateSettings" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/update/status": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateStep" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/update/checkNewVersion": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateStep" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/update/download": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateStep" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateStep" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/System/update/run": { "put": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateStep" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/TimeProfiles": { "get": { "tags": [ "TimeProfiles", "UserManager", "Admin", "AccessManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfileQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfile" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfile" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidTimeProfileBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidPatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/TimeProfiles/{id}": { "get": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfile" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfile" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfile" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfile" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users": { "get": { "tags": [ "Users", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidUserBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidPatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}": { "get": { "tags": [ "Users", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/self": { "get": { "tags": [ "Users", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/roles": { "get": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Users", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Roles" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/password": { "put": { "tags": [ "Users" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/onetimepassword": { "put": { "tags": [ "Users", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/generatepassword": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/avatar": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/sendcredentials": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/mobilekey": { "get": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileKeyPairing" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/mobilekey/pairing/start": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileKeyPairing" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/credentials/{credential}": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "credential", "in": "path", "required": true, "schema": { "enum": [ "MobileKey", "Pin", "QrCode" ], "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/mobilekey/pairing/stop": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/mobilekey/pairing/sendPin": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/pin": { "post": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/qrcode": { "post": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/qr.png": { "get": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Users/{id}/qr.svg": { "get": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/UserSynchronization/import.csv": { "put": { "tags": [ "UserSynchronization", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "encoding": { "file": { "style": "form" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronizationResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/UserSynchronization/run": { "put": { "tags": [ "UserSynchronization", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronizationResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/UserSynchronization/settings": { "get": { "tags": [ "UserSynchronization", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FtpSynchronization" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "UserSynchronization", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FtpSynchronization" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FtpSynchronization" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/UserSynchronization/status": { "get": { "tags": [ "UserSynchronization", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronizationResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/visitors/cards": { "get": { "tags": [ "VisitorCards", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCardQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "VisitorCards", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCard" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCard" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "VisitorCards", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32VisitorCardBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Int32PatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/visitors/cards/{id}": { "get": { "tags": [ "VisitorCards", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCard" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "VisitorCards", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCard" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCard" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "VisitorCards", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCard" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "VisitorCards", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/visitors/cards/search": { "post": { "tags": [ "VisitorCards", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardSearch" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCard" } } } }, "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Visitors": { "get": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Visitor" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Visitor" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidVisitorBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidPatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Visitors/{id}": { "get": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Visitor" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Visitor" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Visitor" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Visitor" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Visitors/{id}/pin": { "post": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Visitor" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Visitors/{id}/qrcode": { "post": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Visitor" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Visitors/{id}/qr.png": { "get": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Visitors/{id}/qr.svg": { "get": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "string", "format": "binary" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Visitors/{id}/sendCredentials": { "put": { "tags": [ "Visitors", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Zones": { "get": { "tags": [ "Zones", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneQueryResult" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Zones", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Zone" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Zone" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Zones", "Admin" ], "description": "Bulk patch will succeed even if some entities are not successfully patched. Details about failed patches are in the response.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidZoneBulkPatchDocument" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidPatchError" } } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v3/Zones/{id}": { "get": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Zone" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Zone" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Zone" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Operation" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Zone" } } } }, "500": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } }, "400": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } } }, "components": { "schemas": { "AccessControl": { "type": "object", "properties": { "LiftEnabled": { "type": "boolean" }, "AccessPoint0Zone": { "$ref": "#/components/schemas/GuidIdName" }, "AccessPoint1Zone": { "$ref": "#/components/schemas/GuidIdName" }, "LiftFloors": { "type": "array", "items": { "$ref": "#/components/schemas/LiftFloor" }, "nullable": true }, "DoorSwitch": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "AccessCredentials": { "type": "object", "properties": { "ValidFrom": { "type": "string", "format": "date-time", "nullable": true }, "ValidTo": { "type": "string", "format": "date-time", "nullable": true }, "Cards": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Fingerprints": { "type": "array", "items": { "$ref": "#/components/schemas/Fingerprint" }, "nullable": true }, "LicensePlates": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true }, "Pin": { "type": "string", "nullable": true }, "QrCode": { "type": "string", "nullable": true }, "MobileKey": { "type": "string", "nullable": true, "readOnly": true }, "IsPairing": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "AccessEventCredentials": { "type": "object", "properties": { "Bluetooth": { "enum": [ "unused", "valid", "invalid" ], "type": "string" }, "Card": { "enum": [ "unused", "valid", "invalid" ], "type": "string" }, "FingerPrint": { "enum": [ "unused", "valid", "invalid" ], "type": "string" }, "Pin": { "enum": [ "unused", "valid", "invalid" ], "type": "string" }, "QrCode": { "enum": [ "unused", "valid", "invalid" ], "type": "string" }, "Remote": { "enum": [ "unused", "valid", "invalid" ], "type": "string" }, "Rex": { "enum": [ "unused", "valid", "invalid" ], "type": "string" }, "LicensePlate": { "enum": [ "unused", "valid", "invalid" ], "type": "string" }, "Credentials": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccessEventData": { "type": "object", "properties": { "Category": { "enum": [ "Unknown", "Granted", "Denied", "Public", "Lockout" ], "type": "string" }, "Time": { "type": "string", "format": "date-time" }, "DeviceTime": { "type": "string", "format": "date-time" }, "Person": { "$ref": "#/components/schemas/AccessEventPerson" }, "Device": { "$ref": "#/components/schemas/AccessEventDevice" }, "ZoneEntered": { "$ref": "#/components/schemas/AccessEventZone" }, "ZoneExited": { "$ref": "#/components/schemas/AccessEventZone" }, "Credentials": { "$ref": "#/components/schemas/AccessEventCredentials" }, "Detail": { "type": "string", "nullable": true }, "SnapshotTimestamp": { "type": "integer", "description": "Unix timestamp of camlog snapshot associated with the event. If no snapshot was taken it is null.", "format": "int32", "nullable": true }, "CreatedTimestamp": { "type": "string", "nullable": true }, "Direction": { "enum": [ "Unknown", "Entry", "Exit" ], "type": "string" }, "AccessPoint": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AccessEventDataQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccessEventData" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AccessEventDevice": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Host": { "type": "string", "nullable": true }, "SerialNumber": { "type": "string", "nullable": true }, "IsDeleted": { "type": "boolean" } }, "additionalProperties": false }, "AccessEventPerson": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "NameAtTimeOfEvent": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "PhoneNumber": { "type": "string", "nullable": true }, "Company": { "$ref": "#/components/schemas/Int32IdName" }, "IsVisitor": { "type": "boolean" } }, "additionalProperties": false }, "AccessEventZone": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "IsDeleted": { "type": "boolean" } }, "additionalProperties": false }, "AccessPoint": { "enum": [ 0, 1 ], "type": "integer", "description": "<ul><li>0 - <i>Ap0</i></li>\n<li>1 - <i>Ap1</i></li>\n</ul>", "format": "int32" }, "AccessRule": { "required": [ "Group", "Zone" ], "type": "object", "properties": { "Group": { "$ref": "#/components/schemas/GuidIdName" }, "Zone": { "$ref": "#/components/schemas/GuidIdName" }, "TimeProfile": { "$ref": "#/components/schemas/GuidIdName" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AccessRuleJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRuleOperation" }, "nullable": true } }, "additionalProperties": false }, "AccessRuleOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccessRuleQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRule" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Account": { "type": "object", "properties": { "Login": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "Settings": { "$ref": "#/components/schemas/AccountSettings" } }, "additionalProperties": false }, "AccountSettings": { "type": "object", "properties": { "PasswordMustBeChanged": { "type": "boolean" }, "ShowWizard": { "type": "boolean" }, "ShowGiveFeedback": { "type": "boolean" }, "Localization": { "enum": [ "Unknown", "En", "Cs", "De", "It", "Ru", "Es", "Fr" ], "type": "string" } }, "additionalProperties": false }, "AcomUpdateSettings": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Beta": { "type": "boolean" }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ActionType": { "enum": [ 0, 1 ], "type": "integer", "description": "<ul><li>0 - <i>Update</i></li>\n<li>1 - <i>Remove</i></li>\n</ul>", "format": "int32" }, "ApplicationError": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 201, 211, 212, 214, 219, 220, 221, 224, 226, 227, 232, 233, 238, 239, 240, 241, 242, 244, 252, 254, 255, 259, 264, 265, 266, 267, 268, 270, 271, 272, 273, 275, 278, 279, 280, 283, 290, 293, 294, 295, 296, 298, 402, 403, 406, 407, 412, 413, 414, 417, 418, 419, 420, 421, 422, 424, 428, 429, 434, 435, 436, 437, 438, 439, 440, 441, 442, 443, 444, 445, 446, 447, 448, 450, 451, 452, 453, 454, 455, 456, 457, 458, 459, 460, 461, 462, 463, 464, 465, 466, 467, 468, 469, 470, 471, 472, 473, 474, 475, 476, 477, 478, 479, 480, 481, 484, 485, 486, 487, 488, 489, 490, 491, 492, 493, 494, 495, 496, 497, 498, 499, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511, 512, 513, 514, 515, 516, 517, 518, 519, 520, 521, 522, 523, 524, 525, 526, 527, 528 ], "type": "integer", "description": "<ul><li>0 - <i>Other</i></li>\n<li>1 - <i>Exists</i></li>\n<li>2 - <i>NotExists</i></li>\n<li>3 - <i>OutdatedData</i></li>\n<li>4 - <i>Unauthorized</i></li>\n<li>5 - <i>InvalidData</i></li>\n<li>6 - <i>CompanyMismatch</i></li>\n<li>201 - <i>DeviceLoginFailed</i></li>\n<li>211 - <i>ExternalSystem</i></li>\n<li>212 - <i>EmailFormatError</i></li>\n<li>214 - <i>BackupDeviceIsBusy</i></li>\n<li>219 - <i>LoginOrPasswordMissing</i></li>\n<li>220 - <i>DeviceNotFound</i></li>\n<li>221 - <i>DayEndNotLaterDayStart</i></li>\n<li>224 - <i>CodeAlreadyExists</i></li>\n<li>226 - <i>MaxNumberOfDevicesExceeded</i></li>\n<li>227 - <i>DuplicateName</i></li>\n<li>232 - <i>InvalidLicense</i></li>\n<li>233 - <i>UnsupportedProduct</i></li>\n<li>238 - <i>WeakPassword</i></li>\n<li>239 - <i>EmailMissing</i></li>\n<li>240 - <i>LoginMissing</i></li>\n<li>241 - <i>PasswordChangeOnDeviceFailed</i></li>\n<li>242 - <i>OldPasswordCheckFailed</i></li>\n<li>244 - <i>UserDoesNotExist</i></li>\n<li>252 - <i>InvalidPhoneNumber</i></li>\n<li>254 - <i>InvalidCodeFormat</i></li>\n<li>255 - <i>DuplicateEmail</i></li>\n<li>259 - <i>InvalidIPAddress</i></li>\n<li>264 - <i>VirtualFormatError</i></li>\n<li>265 - <i>WrongTime</i></li>\n<li>266 - <i>MailerSetting</i></li>\n<li>267 - <i>Validation</i></li>\n<li>268 - <i>InvalidPresenceTimeout</i></li>\n<li>270 - <i>AccessRuleCompanyMismatch</i></li>\n<li>271 - <i>UserHasNoPhoneNumber</i></li>\n<li>272 - <i>DeviceCapabilityMissing</i></li>\n<li>273 - <i>NoVirtualNumber</i></li>\n<li>275 - <i>DeviceAlreadyCreated</i></li>\n<li>278 - <i>DuplicateVirtualNumber</i></li>\n<li>279 - <i>CardIdFormatException</i></li>\n<li>280 - <i>UnauthorizedAgreement</i></li>\n<li>283 - <i>Import</i></li>\n<li>290 - <i>NameCannotBeVoid</i></li>\n<li>293 - <i>TwoCardsAlreadyAssigned</i></li>\n<li>294 - <i>CardIsDuplicate</i></li>\n<li>295 - <i>WrongLicenseFile</i></li>\n<li>296 - <i>EmailSendFailed</i></li>\n<li>298 - <i>SystemAdminMustNotChangeLogin</i></li>\n<li>402 - <i>InvalidIpEyeAddress</i></li>\n<li>403 - <i>LicensedFeatureDisabled</i></li>\n<li>406 - <i>ReplacementWithSameDevice</i></li>\n<li>407 - <i>NoDiagnosticData</i></li>\n<li>412 - <i>VisitStartLaterThanEnd</i></li>\n<li>413 - <i>SmtpIsDisabled</i></li>\n<li>414 - <i>PdfNotFound</i></li>\n<li>417 - <i>WrongDaysOfWeekSpecification</i></li>\n<li>418 - <i>TimeProfileAssignedToAccessRule</i></li>\n<li>419 - <i>DeputySetToSelf</i></li>\n<li>420 - <i>MaxNumberOfFingerprintsExceeded</i></li>\n<li>421 - <i>FingerprintPositionAlreadyUsed</i></li>\n<li>422 - <i>DeviceHasNoAccessControl</i></li>\n<li>424 - <i>CompanyInAccessRule</i></li>\n<li>428 - <i>PinCodeCollisions</i></li>\n<li>429 - <i>TimeProfileAssignedToPublicAccess</i></li>\n<li>434 - <i>FirmwareUpdateFailed</i></li>\n<li>435 - <i>UnsupportedFirmware</i></li>\n<li>436 - <i>FirmwareDeploymentError</i></li>\n<li>437 - <i>DeviceIsDisabled</i></li>\n<li>438 - <i>InvalidPortNumber</i></li>\n<li>439 - <i>DeviceMustBeDisabledPriorReplacement</i></li>\n<li>440 - <i>UserCannotChangeName</i></li>\n<li>441 - <i>UserCannotChangeEmployeeNumber</i></li>\n<li>442 - <i>UserCannotChangeVirtualCard</i></li>\n<li>443 - <i>PairingFailed</i></li>\n<li>444 - <i>PairingCancellationFailed</i></li>\n<li>445 - <i>PairingDeviceUnavailable</i></li>\n<li>446 - <i>ToMustBeLaterThanFrom</i></li>\n<li>447 - <i>CamLogMaxHigherThanOtherLogs</i></li>\n<li>448 - <i>CamLogMinHigherThanOtherLogs</i></li>\n<li>450 - <i>MaxNumberOfResetsExceeded</i></li>\n<li>451 - <i>NameIsTooLong</i></li>\n<li>452 - <i>LiftControlEnabled</i></li>\n<li>453 - <i>CannotResetPasswordInvalidCode</i></li>\n<li>454 - <i>CannotResetPasswordInvalidToken</i></li>\n<li>455 - <i>FailureSendingMailNotSupported</i></li>\n<li>456 - <i>UserIsDisabled</i></li>\n<li>457 - <i>IdtCannotBeDowngraded</i></li>\n<li>458 - <i>LdapInvalidAttributeName</i></li>\n<li>459 - <i>LdapConnectionError</i></li>\n<li>460 - <i>LdapInvalidCredentials</i></li>\n<li>461 - <i>NoUsersToImport</i></li>\n<li>462 - <i>NetworkSettingsCannotBeChanged</i></li>\n<li>463 - <i>UserCannotRemoveSelf</i></li>\n<li>464 - <i>MaxNumberOfUsersExceeded</i></li>\n<li>465 - <i>MaxNumberOfManagersExceeded</i></li>\n<li>466 - <i>TrialEndingFailed</i></li>\n<li>467 - <i>TrialLimitReached</i></li>\n<li>468 - <i>LicensePlateIsTooLong</i></li>\n<li>469 - <i>TooManyLicensePlates</i></li>\n<li>470 - <i>LicenseRenewalFailed</i></li>\n<li>471 - <i>TooManyManagersForRenewal</i></li>\n<li>472 - <i>NoteTooLong</i></li>\n<li>473 - <i>UserCannotChangeNote</i></li>\n<li>474 - <i>DeviceAlreadyAssignedToZone</i></li>\n<li>475 - <i>BothDeviceApsUsed</i></li>\n<li>476 - <i>ZoneAccessPointsDisabled</i></li>\n<li>477 - <i>RequiredValueMissing</i></li>\n<li>478 - <i>ValueRangeExceeded</i></li>\n<li>479 - <i>MaxLengthExceeded</i></li>\n<li>480 - <i>VisitDurationTooLong</i></li>\n<li>481 - <i>ImageTooLarge</i></li>\n<li>484 - <i>WrongQrCodeFormat</i></li>\n<li>485 - <i>BothPinAndQrCodeUsed</i></li>\n<li>486 - <i>OsServicesRequestFailed</i></li>\n<li>487 - <i>DefaultRootPasswordIsSet</i></li>\n<li>488 - <i>TimeProfileAssignedToZone</i></li>\n<li>489 - <i>InvalidNtpServerConfig</i></li>\n<li>490 - <i>NtpServerNotAvailable</i></li>\n<li>491 - <i>InvalidTimeZone</i></li>\n<li>492 - <i>TimeZoneSettingError</i></li>\n<li>493 - <i>ManualTimeSettingError</i></li>\n<li>494 - <i>NetworkSettingError</i></li>\n<li>495 - <i>BackupOrRestoreAlreadyRunning</i></li>\n<li>496 - <i>NotEnoughSpaceForBackup</i></li>\n<li>497 - <i>SmbNoSuchFileOrDirectory</i></li>\n<li>498 - <i>SmbAccessDenied</i></li>\n<li>499 - <i>SmbHostIsDown</i></li>\n<li>500 - <i>SmbOperationInProgress</i></li>\n<li>501 - <i>BackupFileNotFound</i></li>\n<li>502 - <i>BackupFileReadingError</i></li>\n<li>503 - <i>WrongBackupPassword</i></li>\n<li>504 - <i>LowerBackupVersionNotAccepted</i></li>\n<li>505 - <i>HigherBackupVersion</i></li>\n<li>506 - <i>UserCannotChangeAttendance</i></li>\n<li>507 - <i>UserCannotChangeLicensePlates</i></li>\n<li>508 - <i>UserCannotChangePin</i></li>\n<li>509 - <i>HigherImportVersion</i></li>\n<li>510 - <i>WrongImportCredentials</i></li>\n<li>511 - <i>RemoteServerNotResponding</i></li>\n<li>512 - <i>CannotImportFromLocalhost</i></li>\n<li>513 - <i>OsServicesRequestTimeout</i></li>\n<li>514 - <i>CannotDisableItself</i></li>\n<li>515 - <i>CannotDisableAdminOrUserManager</i></li>\n<li>516 - <i>CannotRemoveOwnAdminRights</i></li>\n<li>517 - <i>InvalidFileFormat</i></li>\n<li>518 - <i>SettingNotChanged</i></li>\n<li>519 - <i>WrongPassword</i></li>\n<li>520 - <i>Locked</i></li>\n<li>521 - <i>BulkUpdateAttendanceMonitoring</i></li>\n<li>522 - <i>BulkUpdateRestrictedAccess</i></li>\n<li>523 - <i>FailedToUpdateNtpMode</i></li>\n<li>524 - <i>SmbCouldNotResolveHost</i></li>\n<li>525 - <i>DeviceUnderLockdown</i></li>\n<li>526 - <i>DoorHeldOpen</i></li>\n<li>527 - <i>WrongCaptchaCode</i></li>\n<li>528 - <i>InvalidUpdateFlowTransition</i></li>\n</ul>", "format": "int32" }, "Area": { "type": "object", "properties": { "Ap0EntryDevices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "Ap1EntryDevices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "ApbMode": { "enum": [ "None", "Soft", "Hard" ], "type": "string" }, "ApbTimeout": { "type": "integer", "format": "int32" }, "OccupancyMode": { "enum": [ "None", "Soft", "Hard" ], "type": "string" }, "OccupancyLimit": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "State": { "$ref": "#/components/schemas/AreaState" }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AreaBase": { "type": "object", "properties": { "Ap0EntryDevices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "Ap1EntryDevices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "ApbMode": { "enum": [ "None", "Soft", "Hard" ], "type": "string" }, "ApbTimeout": { "type": "integer", "format": "int32" }, "OccupancyMode": { "enum": [ "None", "Soft", "Hard" ], "type": "string" }, "OccupancyLimit": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AreaIssue": { "type": "object", "properties": { "Type": { "enum": [ "NoDeviceInArea", "NoInputDefined", "DeviceIsMisconfigured", "DeviceIsEnterOfAnotherArea", "DeviceHasInsufficientLicense", "DeviceDisabled", "DeviceDisconnected", "DeviceHasIncompatibleVersion", "DeviceHasRexButton", "DeviceIncompatibleWithHardOccupancyLimit" ], "type": "string" }, "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/AreaIssueDeviceDto" }, "nullable": true } }, "additionalProperties": false }, "AreaIssueDeviceDto": { "type": "object", "properties": { "DeviceId": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Areas": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true } }, "additionalProperties": false }, "AreaJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/AreaOperation" }, "nullable": true } }, "additionalProperties": false }, "AreaOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AreaQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Area" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AreaReset": { "type": "object", "properties": { "ResetTime": { "type": "string", "format": "date-span" }, "DaysOfWeek": { "type": "array", "items": { "enum": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday", "Holiday" ], "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AreaSettings": { "type": "object", "properties": { "NotifyApbViolations": { "type": "boolean" }, "Exceptions": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "Resets": { "type": "array", "items": { "$ref": "#/components/schemas/AreaReset" }, "nullable": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AreaState": { "type": "object", "properties": { "IsActive": { "type": "boolean" }, "Issues": { "type": "array", "items": { "$ref": "#/components/schemas/AreaIssue" }, "nullable": true }, "Blocked": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdNameType" }, "nullable": true }, "CurrentOccupancy": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AttendanceReport": { "type": "object", "properties": { "From": { "type": "string", "format": "date-time" }, "To": { "type": "string", "format": "date-time" }, "TargetHours": { "type": "string", "description": "Format {TotalHours}:{Minutes}", "format": "date-span", "readOnly": true }, "WorkedHours": { "type": "string", "description": "Format {TotalHours}:{Minutes}", "format": "date-span", "readOnly": true }, "WorkingHoursPerDay": { "type": "string", "description": "Format {TotalHours}:{Minutes}", "format": "date-span", "readOnly": true }, "Balance": { "type": "string", "description": "Format {TotalHours}:{Minutes}", "format": "date-span", "readOnly": true }, "Days": { "type": "array", "items": { "$ref": "#/components/schemas/DayAttendance" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AudioTestResultState": { "type": "object", "properties": { "Status": { "enum": [ "Passed", "No", "Failed", "Unknown" ], "type": "string" }, "Timestamp": { "type": "string", "format": "date-time", "nullable": true }, "Problem": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BackupFileList": { "type": "object", "properties": { "BackupFiles": { "type": "array", "items": { "$ref": "#/components/schemas/BackupInfo" }, "nullable": true }, "SmbError": { "type": "boolean" } }, "additionalProperties": false }, "BackupInfo": { "type": "object", "properties": { "FileName": { "type": "string", "nullable": true }, "Created": { "type": "string", "format": "date-time", "nullable": true }, "Version": { "type": "string", "nullable": true }, "Encrypted": { "type": "boolean" }, "Location": { "enum": [ "Local", "Smb", "Upload" ], "type": "string" }, "Size": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "BackupStorageSettings": { "type": "object", "properties": { "Location": { "enum": [ "Local", "Smb", "Upload" ], "type": "string" }, "Host": { "type": "string", "nullable": true }, "Username": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true }, "SmbVersion": { "$ref": "#/components/schemas/ProtocolVersion" } }, "additionalProperties": false }, "BulkAccessRulesDto": { "type": "object", "properties": { "GroupIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "ZoneIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "TimeProfileId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "BusinessHours": { "type": "object", "properties": { "WorkDays": { "uniqueItems": true, "type": "array", "items": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" }, "nullable": true }, "From": { "type": "string", "format": "date-span" }, "To": { "type": "string", "format": "date-span" }, "Holidays": { "type": "array", "items": { "$ref": "#/components/schemas/Holiday" }, "nullable": true } }, "additionalProperties": false }, "Calling": { "type": "object", "properties": { "Buttons": { "type": "array", "items": { "$ref": "#/components/schemas/UserButton" }, "nullable": true }, "VirtualNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/UserVirtualNumber" }, "nullable": true } }, "additionalProperties": false }, "CamLog": { "type": "object", "properties": { "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "EventType": { "enum": [ "KeyPressed", "CallStateChanged", "CodeEntered", "CardEntered", "DeviceState", "KeyReleased", "InputChanged", "OutputChanged", "AudioLoopTest", "MotionDetected", "RegistrationStateChanged", "SwitchStateChanged", "NoiseDetected", "TamperSwitchActivated", "UnauthorizedDoorOpen", "DoorOpenTooLong", "LoginBlocked", "PairingStateChanged", "UserAuthenticated", "RemoteDoorOpen", "MobKeyEntered", "FingerEntered", "UserRejected", "CardHeld", "AccessLimited", "SilentAlarm", "RexActivated", "AccessTaken", "HardwareChanged", "DirectorySaved", "DoorStateChanged", "DtmfEntered", "LiftStatusChanged", "LiftFloorsEnabled", "LiftConfigChanged", "SwitchesBlocked", "LicensePlateRecognized", "ConfigurationChanged", "SwitchOperationChanged", "AccessBlocked" ], "type": "string", "description": "Cannot be changed after CamLog is created" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CamLogJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/CamLogOperation" }, "nullable": true } }, "additionalProperties": false }, "CamLogOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CamLogQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CamLog" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CaptchaVerification": { "type": "object", "properties": { "Login": { "type": "string", "nullable": true }, "VerificationText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CardSearch": { "required": [ "TagId" ], "type": "object", "properties": { "TagId": { "minLength": 1, "type": "string" }, "CompanyId": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Channels": { "type": "object", "properties": { "AppBar": { "type": "boolean" }, "Email": { "type": "boolean" } }, "additionalProperties": false }, "CodeCollision": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Field": { "enum": [ "QrCodeOrPin", "SwitchCode1", "SwitchCode2", "SwitchCode3", "SwitchCode4" ], "type": "string" }, "Id": { "type": "string", "format": "uuid", "readOnly": true }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Company": { "type": "object", "properties": { "Localization": { "enum": [ "Unknown", "En", "Cs", "De", "It", "Ru", "Es", "Fr" ], "type": "string" }, "BusinessHours": { "$ref": "#/components/schemas/BusinessHours" }, "GroupSettings": { "$ref": "#/components/schemas/GroupSettings" }, "CredentialSettings": { "$ref": "#/components/schemas/CredentialSettings" }, "Lockdown": { "$ref": "#/components/schemas/LockdownState" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CompanyJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyOperation" }, "nullable": true } }, "additionalProperties": false }, "CompanyOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CompanyQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Company" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CredentialSettings": { "type": "object", "properties": { "MobileKeyPairingDevices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "MobileKeyPairingTime": { "maximum": 14400, "minimum": 10, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DateAndTimeSetting": { "type": "object", "properties": { "Method": { "enum": [ "Manual", "Ntp" ], "type": "string" }, "NtpServers": { "type": "array", "items": { "type": "string" }, "nullable": true }, "Time": { "type": "string", "format": "date-time", "nullable": true }, "TimeZone": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "DayAttendance": { "type": "object", "properties": { "Day": { "type": "string", "nullable": true, "readOnly": true }, "WorkedHours": { "type": "string", "format": "date-span", "readOnly": true }, "Balance": { "type": "string", "format": "date-span", "readOnly": true }, "Intervals": { "type": "array", "items": { "$ref": "#/components/schemas/WorkInterval" }, "nullable": true, "readOnly": true }, "IsHoliday": { "type": "boolean", "readOnly": true }, "IsWorkingDay": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DayIntervals": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Intervals": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Interval" }, "nullable": true } }, "additionalProperties": false }, "Device": { "type": "object", "properties": { "Hardware": { "$ref": "#/components/schemas/Hardware" }, "Features": { "$ref": "#/components/schemas/Features" }, "State": { "$ref": "#/components/schemas/State" }, "Firmware": { "$ref": "#/components/schemas/Firmware" }, "IpAddress": { "type": "string", "nullable": true }, "Port": { "type": "integer", "format": "int32" }, "Login": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" }, "ExcludedFromFirmwareManagement": { "type": "boolean" }, "AccessControl": { "$ref": "#/components/schemas/AccessControl" }, "Calling": { "$ref": "#/components/schemas/Calling" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DeviceBackup": { "type": "object", "properties": { "SoftwareVersion": { "type": "string", "nullable": true }, "Created": { "type": "string", "format": "date-time" }, "Id": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "DeviceBase": { "type": "object", "properties": { "IpAddress": { "type": "string", "nullable": true }, "Port": { "type": "integer", "format": "int32" }, "Login": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" }, "ExcludedFromFirmwareManagement": { "type": "boolean" }, "AccessControl": { "$ref": "#/components/schemas/AccessControl" }, "Calling": { "$ref": "#/components/schemas/Calling" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DeviceJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceOperation" }, "nullable": true } }, "additionalProperties": false }, "DeviceLockdownState": { "type": "object", "properties": { "State": { "enum": [ "Unknown", "Normal", "Lockdown", "PartialLockdown" ], "type": "string" }, "Confirmed": { "type": "boolean" }, "Overview": { "$ref": "#/components/schemas/LockdownOverview" } }, "additionalProperties": false }, "DeviceOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceProblem": { "type": "object", "properties": { "Type": { "enum": [ "LiftLicenseLost", "LiftModuleDisabled", "LiftModuleDisconnected", "FirmwareUpdateFailed", "FirmwareUpdateRetriesFailed", "MaximumParallelCallReached", "MaximumTreePathReached", "Other" ], "type": "string" }, "AdditionalInfo": { "type": "string", "nullable": true }, "UserId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "DeviceQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Device" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DiskManagementSettings": { "required": [ "AccessLog", "CamLog", "LocalBackups", "SystemLog" ], "type": "object", "properties": { "AccessLog": { "$ref": "#/components/schemas/LogLifespan" }, "SystemLog": { "$ref": "#/components/schemas/LogLifespan" }, "CamLog": { "$ref": "#/components/schemas/LogLifespan" }, "LocalBackups": { "$ref": "#/components/schemas/LogLifespan" }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DiskUsageOldestEvents": { "type": "object", "properties": { "AccessLog": { "type": "string", "format": "date-time", "nullable": true }, "SystemLog": { "type": "string", "format": "date-time", "nullable": true }, "CamLog": { "type": "string", "format": "date-time", "nullable": true }, "LocalBackups": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DiskUsagePercent": { "type": "object", "properties": { "Timestamp": { "type": "string", "format": "date-time" }, "AccessLog": { "type": "number", "format": "double", "readOnly": true }, "SystemLog": { "type": "number", "format": "double", "readOnly": true }, "CamLog": { "type": "number", "format": "double", "readOnly": true }, "LocalBackups": { "type": "number", "format": "double", "readOnly": true }, "Other": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "DiskUsageReport": { "type": "object", "properties": { "Latest": { "$ref": "#/components/schemas/DiskUsagePercent" }, "OldestEvents": { "$ref": "#/components/schemas/DiskUsageOldestEvents" }, "History": { "type": "array", "items": { "$ref": "#/components/schemas/DiskUsagePercent" }, "nullable": true }, "IsLowSpace": { "type": "boolean" } }, "additionalProperties": false }, "DoorState": { "type": "object", "properties": { "Status": { "enum": [ "Closed", "Opened", "TooLong", "Unauthorized", "Unknown" ], "type": "string" }, "Timestamp": { "type": "string", "format": "date-time", "nullable": true }, "Problem": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EmailSettings": { "required": [ "HeaderBackgroundColor", "HeaderTextColor" ], "type": "object", "properties": { "HeaderBackgroundColor": { "minLength": 1, "type": "string" }, "HeaderTextColor": { "minLength": 1, "type": "string" }, "Revision": { "type": "integer", "format": "int32" }, "Templates": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/EmailTemplate" }, "nullable": true } }, "additionalProperties": false }, "EmailTemplate": { "type": "object", "properties": { "Subject": { "maxLength": 128, "type": "string", "nullable": true }, "Header": { "maxLength": 128, "type": "string", "nullable": true }, "Introduction": { "type": "string", "nullable": true }, "Message": { "type": "string", "nullable": true }, "Signature": { "type": "string", "nullable": true } }, "additionalProperties": false }, "EntityCounts": { "type": "object", "properties": { "Companies": { "type": "integer", "format": "int32" }, "Users": { "type": "integer", "format": "int32" }, "Visitors": { "type": "integer", "format": "int32" }, "Groups": { "type": "integer", "format": "int32" }, "Zones": { "type": "integer", "format": "int32" }, "Devices": { "type": "integer", "format": "int32" }, "TimeProfiles": { "type": "integer", "format": "int32" }, "AccessRules": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ErrorResult": { "type": "object", "properties": { "Code": { "$ref": "#/components/schemas/ApplicationError" }, "Message": { "type": "string", "nullable": true }, "Params": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "Detail": { "nullable": true } }, "additionalProperties": false }, "Features": { "type": "object", "properties": { "ButtonCount": { "type": "integer", "format": "int32", "readOnly": true }, "HasAccessControl": { "type": "boolean", "readOnly": true }, "HasDoorControl": { "type": "boolean", "readOnly": true }, "HasLiftControl": { "type": "boolean", "readOnly": true }, "HasSecureCards": { "type": "boolean", "readOnly": true }, "HasVirtualNumbers": { "type": "boolean", "readOnly": true }, "HasSwitchControl": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "FieldDescription": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Finger": { "enum": [ "LeftLittleFinger", "LeftRingFinger", "LeftMiddleFinger", "LeftIndexFinger", "LeftThumb", "RightThumb", "RightIndexFinger", "RightMiddleFinger", "RightRingFinger", "RightLittleFinger" ], "type": "string" }, "Fingerprint": { "type": "object", "properties": { "Finger": { "$ref": "#/components/schemas/Finger" }, "Template": { "type": "string", "nullable": true }, "OpensDoor": { "type": "boolean" }, "TriggersSilentAlarm": { "type": "boolean" }, "ExecutesAutomation1": { "type": "boolean" }, "ExecutesAutomation2": { "type": "boolean" } }, "additionalProperties": false }, "Firmware": { "type": "object", "properties": { "IsSupported": { "type": "boolean", "readOnly": true }, "IsApproved": { "type": "boolean", "readOnly": true }, "Version": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "FirmwareChange": { "type": "object", "additionalProperties": false }, "FirmwareDeployment": { "type": "object", "properties": { "FirmwareKey": { "type": "string", "nullable": true, "readOnly": true }, "DeviceType": { "type": "string", "nullable": true }, "TargetVersion": { "type": "string", "nullable": true }, "CandidateVersion": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "FirmwareDeploymentStatus": { "type": "object", "properties": { "Deployment": { "$ref": "#/components/schemas/FirmwareDeployment" }, "FailedUpdates": { "type": "integer", "format": "int32" }, "PendingUpdates": { "type": "integer", "format": "int32" }, "TotalUpdates": { "type": "integer", "format": "int32" }, "TotalDevices": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FtpConnection": { "type": "object", "properties": { "FileUrl": { "type": "string", "nullable": true }, "Username": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true }, "UseSSL": { "type": "boolean" } }, "additionalProperties": false }, "FtpSynchronization": { "type": "object", "properties": { "Connection": { "$ref": "#/components/schemas/FtpConnection" }, "Schedule": { "$ref": "#/components/schemas/SynchronizationSchedule" } }, "additionalProperties": false }, "Group": { "type": "object", "properties": { "Members": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid", "readOnly": true }, "Company": { "$ref": "#/components/schemas/Int32IdName" }, "MemberCount": { "type": "integer", "format": "int32", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GroupJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/GroupOperation" }, "nullable": true } }, "additionalProperties": false }, "GroupOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GroupQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Group" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GroupSettings": { "type": "object", "properties": { "PredefinedVisitorGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "VisitorManagerGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true } }, "additionalProperties": false }, "GuidEntity": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "GuidGroupBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "GuidIdName": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GuidIdNameType": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GuidPatchError": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Error": { "$ref": "#/components/schemas/ErrorResult" } }, "additionalProperties": false }, "GuidSearchResult": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "Pattern": { "type": "string", "nullable": true }, "Properties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" }, "nullable": true } }, "additionalProperties": false }, "GuidTimeProfileBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "GuidUserBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "GuidVisitorBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "GuidZoneBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "Hardware": { "type": "object", "properties": { "SerialNumber": { "type": "string", "nullable": true, "readOnly": true }, "ProductName": { "type": "string", "nullable": true, "readOnly": true }, "DevType": { "type": "string", "nullable": true, "readOnly": true }, "MacAddress": { "type": "string", "nullable": true, "readOnly": true }, "IsAnsweringUnit": { "type": "boolean", "readOnly": true }, "IsIndoorTouch": { "type": "boolean", "readOnly": true }, "IsIndoorTouch2": { "type": "boolean", "readOnly": true }, "HasDisplay": { "type": "boolean", "readOnly": true }, "KeypadConnected": { "type": "boolean", "readOnly": true }, "HasCamera": { "type": "boolean", "readOnly": true }, "HasSnapshotCamera": { "type": "boolean", "readOnly": true }, "HasDoorSensor": { "type": "boolean", "readOnly": true }, "HasRexButton": { "type": "boolean", "readOnly": true }, "AccessPoint0Modules": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareModule" }, "nullable": true, "readOnly": true }, "AccessPoint1Modules": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareModule" }, "nullable": true, "readOnly": true }, "HasDisplayFolderImages": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "HardwareModule": { "type": "object", "properties": { "SerialNumber": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Holiday": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "IsRecurring": { "type": "boolean" }, "Date": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "IdName": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IdNameType": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ImportRequest": { "type": "object", "properties": { "Host": { "type": "string", "nullable": true }, "Username": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IncompatibleFirmware": { "type": "object", "properties": { "Version": { "type": "string", "nullable": true }, "DeviceType": { "type": "string", "nullable": true }, "IsApproved": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "IncompatibleFirmwareQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/IncompatibleFirmware" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Int32AccessRuleBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "Int32AreaBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "Int32CamLogBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "Int32CompanyBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "Int32DeviceBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "Int32IdName": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Int32NotificationBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "Int32PatchError": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Error": { "$ref": "#/components/schemas/ErrorResult" } }, "additionalProperties": false }, "Int32SearchResult": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "Pattern": { "type": "string", "nullable": true }, "Properties": { "type": "array", "items": { "$ref": "#/components/schemas/Property" }, "nullable": true } }, "additionalProperties": false }, "Int32VisitorCardBulkPatchDocument": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" } } }, "additionalProperties": false }, "Interval": { "type": "object", "properties": { "From": { "type": "string", "format": "date-span" }, "To": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "JobStatus": { "type": "object", "properties": { "Timestamp": { "type": "string", "format": "date-time", "nullable": true }, "State": { "enum": [ "Unknown", "InProgress", "Successful", "Failed" ], "type": "string" } }, "additionalProperties": false }, "LdapConnectionSettings": { "required": [ "Host", "Password", "Username" ], "type": "object", "properties": { "Host": { "minLength": 1, "type": "string" }, "Port": { "type": "integer", "format": "int32" }, "Username": { "minLength": 1, "type": "string" }, "Password": { "minLength": 1, "type": "string" }, "UseSSL": { "type": "boolean" } }, "additionalProperties": false }, "LdapFieldMap": { "required": [ "UserNameAttribute" ], "type": "object", "properties": { "UserIdAttribute": { "type": "string", "nullable": true }, "UserNameAttribute": { "minLength": 1, "type": "string" }, "UserLoginAttribute": { "type": "string", "nullable": true }, "EmailAttribute": { "type": "string", "nullable": true }, "EmployeeIdAttribute": { "type": "string", "nullable": true }, "PhoneNumbers1Attribute": { "type": "string", "nullable": true }, "PhoneNumbers2Attribute": { "type": "string", "nullable": true }, "PhoneNumbers3Attribute": { "type": "string", "nullable": true }, "PinCodeAttribute": { "type": "string", "nullable": true }, "CardNumber1Attribute": { "type": "string", "nullable": true }, "CardNumber2Attribute": { "type": "string", "nullable": true }, "LicensePlatesAttribute": { "type": "string", "nullable": true }, "AvatarAttribute": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LdapFields": { "type": "object", "properties": { "NextSynchronization": { "type": "string", "format": "date-time", "nullable": true }, "SynchronizedFields": { "$ref": "#/components/schemas/SynchronizedFields" } }, "additionalProperties": false }, "LdapGroupMap": { "type": "object", "properties": { "GroupNameAttribute": { "type": "string", "nullable": true }, "GroupMemberAttribute": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LdapQuerySettings": { "required": [ "BaseDN" ], "type": "object", "properties": { "BaseDN": { "minLength": 1, "type": "string" }, "AdditionalUserDN": { "type": "string", "nullable": true }, "AdditionalGroupDN": { "type": "string", "nullable": true }, "UserFilter": { "type": "string", "nullable": true }, "NestedSearch": { "type": "boolean" }, "FollowReferral": { "type": "boolean" }, "PageSize": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "GroupFilter": { "type": "string", "nullable": true }, "NestedGroups": { "type": "boolean" }, "UsePagination": { "type": "boolean", "readOnly": true }, "UserBaseDn": { "type": "string", "nullable": true, "readOnly": true }, "GroupBaseDn": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "LdapSettings": { "type": "object", "properties": { "Connection": { "$ref": "#/components/schemas/LdapConnectionSettings" }, "Query": { "$ref": "#/components/schemas/LdapQuerySettings" }, "Synchronization": { "$ref": "#/components/schemas/LdapSynchronizationSettings" } }, "additionalProperties": false }, "LdapSynchronizationSettings": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "FieldMap": { "$ref": "#/components/schemas/LdapFieldMap" }, "ImportAvatar": { "type": "boolean" }, "MissingUsersSynchronizationAction": { "enum": [ "Keep", "Disable", "Delete" ], "type": "string" }, "SyncDisabledFlag": { "type": "boolean" }, "SyncGroups": { "type": "boolean" }, "GroupMap": { "$ref": "#/components/schemas/LdapGroupMap" }, "LastSyncTime": { "type": "string", "format": "date-time", "nullable": true }, "NextSyncTime": { "type": "string", "format": "date-time", "nullable": true }, "LastSyncSuccess": { "type": "boolean" }, "StartTime": { "type": "string", "format": "date-span" }, "Frequency": { "enum": [ "Off", "Hourly", "Daily", "Weekly" ], "type": "string" }, "DayOfWeek": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" } }, "additionalProperties": false }, "LicenseFeatures": { "type": "object", "properties": { "Notifications": { "type": "boolean" }, "UserRoles": { "type": "boolean" }, "Presence": { "type": "boolean" }, "UserLimit": { "type": "integer", "format": "int32" }, "DeviceLimit": { "type": "integer", "format": "int32" }, "CamLogs": { "type": "boolean" }, "ManagerLimit": { "type": "integer", "format": "int32" }, "MobileKeyLocal": { "type": "boolean" }, "UserSynchronization": { "type": "boolean" }, "Attendance": { "type": "boolean" }, "FirmwareManagement": { "type": "boolean" }, "Visitors": { "type": "boolean" }, "Antipassback": { "type": "boolean" }, "Dashboard": { "type": "boolean" }, "Lockdown": { "type": "boolean" }, "InstallationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "LicenseInfo": { "type": "object", "properties": { "LicenseDeviceSN": { "type": "string", "nullable": true }, "Uploaded": { "type": "string", "format": "date-time", "nullable": true }, "Expires": { "type": "string", "nullable": true }, "RemainingUsers": { "type": "integer", "format": "int32" }, "RemainingDevices": { "type": "integer", "format": "int32" }, "RemainingManagers": { "type": "integer", "format": "int32" }, "LicenseTier": { "enum": [ "Old", "Basic", "Trial", "Advanced", "Pro", "Unlimited" ], "type": "string" }, "Features": { "$ref": "#/components/schemas/LicenseFeatures" } }, "additionalProperties": false }, "LiftDevice": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Name": { "type": "string", "nullable": true, "readOnly": true }, "Modules": { "type": "array", "items": { "$ref": "#/components/schemas/LiftModule" }, "nullable": true, "readOnly": true }, "Floors": { "type": "array", "items": { "$ref": "#/components/schemas/LiftFloor" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "LiftFloor": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "PublicAccess": { "type": "boolean" }, "PublicAccessProfile": { "$ref": "#/components/schemas/GuidIdName" }, "Zone": { "$ref": "#/components/schemas/GuidIdName" }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Enabled": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "LiftModule": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "IpAddress": { "type": "string", "nullable": true }, "IsOnline": { "type": "boolean" }, "SerialNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LockdownOverview": { "type": "object", "properties": { "TotalDevices": { "type": "integer", "format": "int32" }, "LockdownDevices": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LockdownRequest": { "type": "object", "properties": { "DeviceIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "ZoneId": { "type": "string", "format": "uuid", "nullable": true }, "CompanyId": { "type": "integer", "format": "int32", "nullable": true }, "Global": { "type": "boolean" } }, "additionalProperties": false }, "LockdownState": { "type": "object", "properties": { "State": { "enum": [ "Unknown", "Normal", "Lockdown", "PartialLockdown" ], "type": "string", "readOnly": true }, "Confirmed": { "type": "boolean", "readOnly": true }, "Overview": { "$ref": "#/components/schemas/LockdownOverview" } }, "additionalProperties": false }, "LockdownUpdateMessage": { "type": "object", "properties": { "Type": { "enum": [ "Device", "Zone", "Company", "Global" ], "type": "string" }, "DeviceId": { "type": "integer", "format": "int32", "nullable": true }, "ZoneId": { "type": "string", "format": "uuid", "nullable": true }, "CompanyId": { "type": "integer", "format": "int32", "nullable": true }, "State": { "enum": [ "Unknown", "Normal", "Lockdown", "PartialLockdown" ], "type": "string" }, "Confirmed": { "type": "boolean", "nullable": true }, "Overview": { "$ref": "#/components/schemas/LockdownOverview" } }, "additionalProperties": false }, "LogLifespan": { "type": "object", "properties": { "MaximumRetention": { "maximum": 365, "minimum": 1, "type": "integer", "format": "int32" }, "MinimumRetention": { "maximum": 365, "minimum": 1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LoginData": { "required": [ "Login", "Password" ], "type": "object", "properties": { "Login": { "minLength": 1, "type": "string" }, "Password": { "minLength": 1, "type": "string" }, "LongTimeLogin": { "type": "boolean" } }, "additionalProperties": false }, "MailTest": { "required": [ "EmailTo" ], "type": "object", "properties": { "EmailTo": { "minLength": 1, "type": "string", "format": "email" }, "TemplateType": { "enum": [ "VisitorPin", "VisitorQrCode", "UserPin", "UserQrCode", "UserMobileKey" ], "type": "string" }, "TemplateData": { "$ref": "#/components/schemas/EmailTemplate" } }, "additionalProperties": false }, "MobileKeyKeyInfo": { "type": "object", "properties": { "KeyId": { "type": "string", "nullable": true }, "Created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MobileKeyLocationData": { "type": "object", "properties": { "Location": { "type": "string", "nullable": true }, "KeyId": { "type": "string", "nullable": true }, "PublicKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MobileKeyPairing": { "type": "object", "properties": { "Pin": { "type": "string", "nullable": true }, "Until": { "type": "string", "format": "date-time" }, "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true } }, "additionalProperties": false }, "MultiFactorAuthentication": { "type": "object", "properties": { "TimeProfile": { "$ref": "#/components/schemas/GuidIdName" }, "RequiredOnlyOnEntry": { "type": "boolean" }, "CardRequired": { "type": "boolean" }, "CodeRequired": { "type": "boolean" }, "FingerprintRequired": { "type": "boolean" }, "MobileKeyRequired": { "type": "boolean" } }, "additionalProperties": false }, "NetworkSettings": { "type": "object", "properties": { "Method": { "enum": [ "Dhcp", "Manual" ], "type": "string" }, "IpAddress": { "type": "string", "nullable": true }, "Netmask": { "type": "string", "nullable": true }, "DefaultGateway": { "type": "string", "nullable": true }, "NameServer1": { "type": "string", "nullable": true }, "NameServer2": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Notification": { "type": "object", "properties": { "Events": { "type": "array", "items": { "enum": [ "DeviceState", "AudioLoopTest", "SipProxyState", "TamperSwitch", "UnauthorizedDoorOpen", "DoorOpenTooLong", "LoginBlocked", "LicenseIssues", "CsvSyncFailure", "UnsupportedFirmware", "RestrictionAreaState", "AntiPassbackViolation", "SilentAlarm", "ThirdPartyUsersWithAccess", "DirectoryLimitExceeded", "LiftModuleState", "DiskUsageHigh", "AccessModuleLocked", "SystemUpdateAvailable", "FirmwareUpdateFailed", "LdapSyncFailure", "FirmwareUpdateAvailable", "Lockdown", "OccupancyLimitReached", "PeriodicBackupFailed", "DeviceTimeSynchronizationError" ], "type": "string" }, "nullable": true }, "MonitorAllDevices": { "type": "boolean" }, "MonitoredDevices": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "Channels": { "$ref": "#/components/schemas/Channels" }, "Recipients": { "$ref": "#/components/schemas/Recipients" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "NotificationJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationOperation" }, "nullable": true } }, "additionalProperties": false }, "NotificationOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NotificationQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Notification" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Operation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PasswordChange": { "type": "object", "properties": { "OldPassword": { "type": "string", "nullable": true }, "NewPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PasswordSetRequest": { "required": [ "NewPassword", "Token" ], "type": "object", "properties": { "Token": { "maxLength": 40, "minLength": 1, "type": "string" }, "NewPassword": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "PeriodicBackupSetting": { "type": "object", "properties": { "Frequency": { "enum": [ "Daily", "Weekly", "Monthly" ], "type": "string" }, "DayOfWeek": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" }, "Password": { "type": "string", "nullable": true }, "StartTime": { "type": "string", "format": "date-span" }, "DayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Person": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "PhoneNumber": { "type": "string", "nullable": true }, "Company": { "$ref": "#/components/schemas/Int32IdName" } }, "additionalProperties": false }, "PhoneNumber": { "type": "object", "properties": { "Number": { "type": "string", "nullable": true }, "TimeProfile": { "$ref": "#/components/schemas/GuidIdName" }, "CallNextNumberSimultaneously": { "type": "boolean" }, "IpEyeAddress": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Phonebook": { "type": "object", "properties": { "Nodes": { "type": "array", "items": { "$ref": "#/components/schemas/PhonebookNode" }, "nullable": true } }, "additionalProperties": false }, "PhonebookNode": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Type": { "enum": [ "User", "Group", "CallGroup", "Folder" ], "type": "string" }, "Priority": { "type": "integer", "format": "int32", "nullable": true }, "IsCallGroup": { "type": "boolean" }, "Highlight": { "type": "boolean" }, "Nodes": { "type": "array", "items": { "$ref": "#/components/schemas/PhonebookNode" }, "nullable": true }, "ImageUrl": { "type": "string", "nullable": true }, "ImageData": { "type": "string", "format": "byte", "nullable": true }, "GroupName": { "type": "string", "nullable": true }, "HasNodes": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "PresentPerson": { "type": "object", "properties": { "Person": { "$ref": "#/components/schemas/Person" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "Timestamp": { "type": "string", "format": "date-time" }, "Device": { "$ref": "#/components/schemas/Int32IdName" }, "Zone": { "$ref": "#/components/schemas/GuidIdName" }, "IsExit": { "type": "boolean" }, "Action": { "enum": [ "Add", "Remove", "Update" ], "type": "string" } }, "additionalProperties": false }, "Property": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ProtocolVersion": { "enum": [ "2.0", "1.0", "3.0" ], "type": "string" }, "ProxySetting": { "type": "object", "properties": { "HttpProxy": { "type": "string", "format": "uri", "nullable": true }, "HttpsProxy": { "type": "string", "format": "uri", "nullable": true }, "FtpProxy": { "type": "string", "format": "uri", "nullable": true }, "SocksProxy": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "ReaderSettings": { "type": "object", "properties": { "Rfid125kEnabled": { "type": "boolean" }, "Rfid13M56Enabled": { "type": "boolean" }, "FingerprintEnabled": { "type": "boolean" }, "BluetoothEnabled": { "type": "boolean" }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Recipient": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Recipients": { "type": "object", "properties": { "Users": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Recipient" }, "nullable": true }, "External": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RelayState": { "type": "object", "properties": { "Status": { "enum": [ "False", "True", "Unknown" ], "type": "string" }, "Timestamp": { "type": "string", "format": "date-time", "nullable": true }, "Problem": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReleaseNotes": { "type": "object", "properties": { "Version": { "type": "string", "nullable": true }, "Text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReportInfo": { "type": "object", "properties": { "IsCustom": { "type": "boolean" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "RestoreRequest": { "type": "object", "properties": { "FileName": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true }, "LowerVersionAccepted": { "type": "boolean" }, "Location": { "enum": [ "Local", "Smb", "Upload" ], "type": "string" } }, "additionalProperties": false }, "Roles": { "type": "object", "properties": { "VisitorCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "DoorDevices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "AttendanceGroups": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "IsAdmin": { "type": "boolean" }, "IsAccessManager": { "type": "boolean" }, "IsUserManager": { "type": "boolean" }, "IsVisitorManager": { "type": "boolean" }, "IsDoorManager": { "type": "boolean" }, "IsAttendanceManager": { "type": "boolean" } }, "additionalProperties": false }, "SearchResults": { "type": "object", "properties": { "ResultsGuid": { "type": "array", "items": { "$ref": "#/components/schemas/GuidSearchResult" }, "nullable": true }, "ResultsInt": { "type": "array", "items": { "$ref": "#/components/schemas/Int32SearchResult" }, "nullable": true } }, "additionalProperties": false }, "SecureCardKeyInfo": { "type": "object", "properties": { "Description": { "type": "string", "nullable": true }, "Hash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SecureCardKeysImport": { "required": [ "Payload" ], "type": "object", "properties": { "Password": { "type": "string", "nullable": true }, "Payload": { "type": "string", "format": "byte" } }, "additionalProperties": false }, "SipRegistrationState": { "type": "object", "properties": { "Status": { "enum": [ "Unregistered", "Registering", "Registered", "Unregistering", "Error", "Unknown" ], "type": "string" }, "Timestamp": { "type": "string", "format": "date-time", "nullable": true }, "Problem": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SmtpSettings": { "required": [ "FromAddress", "Host" ], "type": "object", "properties": { "Host": { "minLength": 1, "type": "string" }, "Username": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true }, "FromAddress": { "minLength": 1, "type": "string", "format": "email" }, "Enabled": { "type": "boolean" }, "Ssl": { "type": "boolean" }, "ValidateCertificate": { "type": "boolean" }, "UseLegacyMode": { "type": "boolean" }, "Revision": { "type": "integer", "format": "int32" }, "Port": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Snapshot": { "type": "object", "properties": { "Timestamp": { "type": "string", "format": "date-time" }, "ImageUrl": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "State": { "type": "object", "properties": { "HeldOpen": { "type": "boolean" }, "HoldOpenUntil": { "type": "string", "format": "date-time", "nullable": true }, "Lockdown": { "$ref": "#/components/schemas/DeviceLockdownState" }, "LiftModules": { "type": "array", "items": { "$ref": "#/components/schemas/LiftModule" }, "nullable": true }, "IsLicensedDevice": { "type": "boolean", "readOnly": true }, "Status": { "enum": [ "Unknown", "CertificateInvalid", "Inaccessible", "LoginFailed", "Online", "Disabled", "Incompatible" ], "type": "string", "readOnly": true }, "UpTime": { "type": "integer", "format": "int32", "readOnly": true }, "Sip1": { "$ref": "#/components/schemas/SipRegistrationState" }, "Sip2": { "$ref": "#/components/schemas/SipRegistrationState" }, "AudioLoopTest": { "$ref": "#/components/schemas/AudioTestResultState" }, "TamperSwitch": { "$ref": "#/components/schemas/TriggerState" }, "Door": { "$ref": "#/components/schemas/DoorState" }, "Out": { "$ref": "#/components/schemas/RelayState" }, "Problems": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceProblem" }, "nullable": true, "readOnly": true }, "CanLockdown": { "type": "boolean", "readOnly": true }, "BackupStatus": { "$ref": "#/components/schemas/JobStatus" }, "RestoreStatus": { "$ref": "#/components/schemas/JobStatus" }, "UploadStatus": { "$ref": "#/components/schemas/JobStatus" }, "HasBackup": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SynchronizationResult": { "type": "object", "properties": { "LastSynchronization": { "type": "string", "format": "date-time", "nullable": true }, "NextSynchronization": { "type": "string", "format": "date-time", "nullable": true }, "Status": { "enum": [ "Unknown", "InProgress", "Successful", "Failed", "WithErrors" ], "type": "string" } }, "additionalProperties": false }, "SynchronizationSchedule": { "type": "object", "properties": { "StartTime": { "type": "string", "format": "date-span" }, "Frequency": { "enum": [ "Off", "Hourly", "Daily", "Weekly" ], "type": "string" }, "DayOfWeek": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string" } }, "additionalProperties": false }, "SynchronizedFields": { "type": "object", "properties": { "Name": { "type": "boolean" }, "Email": { "type": "boolean" }, "EmployeeId": { "type": "boolean" }, "PhoneNumbers1": { "type": "boolean" }, "PhoneNumbers2": { "type": "boolean" }, "PhoneNumbers3": { "type": "boolean" }, "PinCode": { "type": "boolean" }, "CardNumber1": { "type": "boolean" }, "CardNumber2": { "type": "boolean" }, "LicensePlates": { "type": "boolean" }, "Avatar": { "type": "boolean" }, "Group": { "type": "boolean" }, "PhoneNumber": { "type": "boolean", "readOnly": true }, "Card": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "SystemLogData": { "type": "object", "properties": { "Category": { "enum": [ "DeviceState", "Import", "UserSynchronization", "System", "UserAction", "AreaRestrictions" ], "type": "string" }, "Time": { "type": "string", "format": "date-time" }, "Severity": { "enum": [ "Info", "Warn", "Error" ], "type": "string" }, "Subject": { "$ref": "#/components/schemas/IdNameType" }, "Event": { "type": "string", "nullable": true }, "EventType": { "enum": [ "DeviceState", "AudioLoopTest", "SipProxyState", "TamperSwitch", "UnauthorizedDoorOpen", "DoorOpenTooLong", "LoginBlocked", "LicenseIssues", "CsvSyncFailure", "UnsupportedFirmware", "RestrictionAreaState", "AntiPassbackViolation", "SilentAlarm", "ThirdPartyUsersWithAccess", "DirectoryLimitExceeded", "LiftModuleState", "DiskUsageHigh", "AccessModuleLocked", "SystemUpdateAvailable", "FirmwareUpdateFailed", "LdapSyncFailure", "FirmwareUpdateAvailable", "Lockdown", "OccupancyLimitReached", "PeriodicBackupFailed", "DeviceTimeSynchronizationError" ], "type": "string", "nullable": true }, "Author": { "$ref": "#/components/schemas/IdName" }, "Detail": { "type": "string", "nullable": true }, "SnapshotTimestamp": { "type": "integer", "description": "Unix timestamp of camlog snapshot associated with the event. If no snapshot was taken it is null.", "format": "int32", "nullable": true }, "CreatedTimestamp": { "type": "string", "nullable": true }, "NotificationTriggered": { "type": "boolean" } }, "additionalProperties": false }, "SystemLogDataQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/SystemLogData" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SystemResourcesInfo": { "type": "object", "properties": { "DiskUsage": { "type": "integer", "format": "int32" }, "MemoryUsage": { "type": "number", "format": "float" }, "CpuUsage": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "SystemTime": { "type": "object", "properties": { "Utc": { "type": "string", "format": "date-time" }, "Local": { "type": "string", "format": "date-time" }, "UtcOffset": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "SystemUpdateStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "<ul><li>0 - <i>UpToDate</i></li>\n<li>1 - <i>UpdateAvailable</i></li>\n<li>2 - <i>ServerUnavailable</i></li>\n<li>3 - <i>Downloading</i></li>\n<li>4 - <i>ReadyToUpdate</i></li>\n<li>5 - <i>Updating</i></li>\n<li>6 - <i>UpdateError</i></li>\n</ul>", "format": "int32" }, "SystemUpdateStep": { "type": "object", "properties": { "ReleaseDate": { "type": "string", "format": "date-time" }, "Version": { "type": "string", "nullable": true }, "ReleaseNotes": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseNotes" }, "nullable": true }, "ProgressPercentage": { "type": "integer", "format": "int32" }, "Status": { "$ref": "#/components/schemas/SystemUpdateStatus" } }, "additionalProperties": false }, "TimeProfile": { "type": "object", "properties": { "PositionOnDevices": { "type": "integer", "format": "int32", "nullable": true }, "Monday": { "$ref": "#/components/schemas/DayIntervals" }, "Tuesday": { "$ref": "#/components/schemas/DayIntervals" }, "Wednesday": { "$ref": "#/components/schemas/DayIntervals" }, "Thursday": { "$ref": "#/components/schemas/DayIntervals" }, "Friday": { "$ref": "#/components/schemas/DayIntervals" }, "Saturday": { "$ref": "#/components/schemas/DayIntervals" }, "Sunday": { "$ref": "#/components/schemas/DayIntervals" }, "Holiday": { "$ref": "#/components/schemas/DayIntervals" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid", "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TimeProfileJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/TimeProfileOperation" }, "nullable": true } }, "additionalProperties": false }, "TimeProfileOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TimeProfileQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/TimeProfile" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TopicDescription": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Description": { "type": "string", "nullable": true }, "Roles": { "type": "array", "items": { }, "nullable": true }, "CanFilter": { "type": "boolean" }, "CanFetch": { "type": "boolean" }, "CanUpdate": { "type": "boolean" }, "Filter": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDescription" }, "nullable": true }, "DataFields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDescription" }, "nullable": true } }, "additionalProperties": false }, "TriggerState": { "type": "object", "properties": { "Status": { "enum": [ "Out", "In" ], "type": "string" }, "Timestamp": { "type": "string", "format": "date-time", "nullable": true }, "Problem": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UptimeUpdateMessage": { "type": "object", "properties": { "ServerTime": { "type": "string", "format": "date-time" }, "Uptime": { "type": "string", "format": "date-span" }, "Counter": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "User": { "type": "object", "properties": { "IsSysAdmin": { "type": "boolean", "readOnly": true }, "IsEnabled": { "type": "boolean" }, "Note": { "type": "string", "nullable": true }, "AttendanceMonitored": { "type": "boolean" }, "AccessCredentials": { "$ref": "#/components/schemas/AccessCredentials" }, "Account": { "$ref": "#/components/schemas/Account" }, "Calling": { "$ref": "#/components/schemas/UserCalling" }, "Integration": { "$ref": "#/components/schemas/UserIntegration" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid", "readOnly": true }, "Company": { "$ref": "#/components/schemas/Int32IdName" }, "AvatarUrl": { "type": "string", "nullable": true, "readOnly": true }, "PinCollisions": { "type": "array", "items": { "$ref": "#/components/schemas/CodeCollision" }, "nullable": true, "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserButton": { "type": "object", "properties": { "Users": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "ButtonNumber": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserCalling": { "type": "object", "properties": { "VirtualNumber": { "type": "string", "nullable": true }, "PhoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumber" }, "nullable": true }, "Deputy": { "$ref": "#/components/schemas/GuidIdName" } }, "additionalProperties": false }, "UserIntegration": { "type": "object", "properties": { "ExternalId": { "type": "string", "nullable": true }, "VirtualCredential": { "type": "string", "nullable": true }, "FromExternalSystem": { "type": "boolean" }, "SwitchCodes": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UserJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/UserOperation" }, "nullable": true } }, "additionalProperties": false }, "UserOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/User" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserUpdate": { "type": "object", "properties": { "Action": { "$ref": "#/components/schemas/ActionType" }, "User": { "$ref": "#/components/schemas/User" } }, "additionalProperties": false }, "UserVirtualNumber": { "type": "object", "properties": { "User": { "$ref": "#/components/schemas/GuidIdName" }, "VirtualNumber": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "Visitor": { "required": [ "Company", "Name", "VisitTo" ], "type": "object", "properties": { "PinCollisions": { "type": "array", "items": { "$ref": "#/components/schemas/CodeCollision" }, "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" }, "Id": { "type": "string", "format": "uuid" }, "Name": { "maxLength": 60, "minLength": 1, "type": "string" }, "Company": { "$ref": "#/components/schemas/Int32IdName" }, "Email": { "type": "string", "format": "email", "nullable": true }, "Phone": { "maxLength": 255, "type": "string", "nullable": true }, "VisitorCompany": { "maxLength": 255, "type": "string", "nullable": true }, "VisitedPerson": { "maxLength": 255, "type": "string", "nullable": true }, "VisitedPersonId": { "type": "string", "format": "uuid", "nullable": true }, "Enabled": { "type": "boolean" }, "Note": { "maxLength": 1024, "type": "string", "nullable": true }, "VisitFrom": { "type": "string", "format": "date-time", "nullable": true }, "VisitTo": { "type": "string", "format": "date-time" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "Credentials": { "$ref": "#/components/schemas/VisitorCredentialsDto" }, "AvatarUrl": { "type": "string", "nullable": true, "readOnly": true }, "State": { "$ref": "#/components/schemas/VisitorState" } }, "additionalProperties": false }, "VisitorCard": { "required": [ "TagId" ], "type": "object", "properties": { "TagId": { "minLength": 1, "type": "string" }, "Visitor": { "$ref": "#/components/schemas/GuidIdName" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true }, "Company": { "$ref": "#/components/schemas/Int32IdName" }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VisitorCardJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/VisitorCardOperation" }, "nullable": true } }, "additionalProperties": false }, "VisitorCardOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitorCardQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/VisitorCard" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VisitorCredentialsDto": { "type": "object", "properties": { "Card": { "type": "string", "nullable": true }, "Pin": { "type": "string", "nullable": true }, "QrCode": { "type": "string", "nullable": true }, "LicensePlate": { "maxLength": 10, "type": "string", "nullable": true }, "VisitorCardInternal": { "$ref": "#/components/schemas/VisitorCard" } }, "additionalProperties": false }, "VisitorJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/VisitorOperation" }, "nullable": true } }, "additionalProperties": false }, "VisitorOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitorQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Visitor" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VisitorState": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "<ul><li>0 - <i>Planned</i></li>\n<li>1 - <i>Active</i></li>\n<li>2 - <i>Incomplete</i></li>\n<li>3 - <i>Closed</i></li>\n</ul>", "format": "int32" }, "WorkInterval": { "type": "object", "properties": { "From": { "type": "string", "format": "date-time", "nullable": true }, "To": { "type": "string", "format": "date-time", "nullable": true }, "Note": { "type": "string", "nullable": true }, "IsEdited": { "type": "boolean", "readOnly": true }, "Id": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "Zone": { "type": "object", "properties": { "MultiFactorAuthentication": { "$ref": "#/components/schemas/MultiFactorAuthentication" }, "Companies": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "AccessPoints": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneAccessPoint" }, "nullable": true }, "Lockdown": { "$ref": "#/components/schemas/LockdownState" }, "ZonalCode": { "type": "string", "nullable": true }, "SilentAlarmEnabled": { "type": "boolean" }, "LimitFailedAccesses": { "type": "boolean" }, "LicensePlatesEnabled": { "type": "boolean" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid", "readOnly": true }, "DeviceCount": { "type": "integer", "format": "int32", "readOnly": true }, "LiftAccess": { "type": "array", "items": { "$ref": "#/components/schemas/LiftDevice" }, "nullable": true, "readOnly": true }, "Problems": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneProblem" }, "nullable": true, "readOnly": true }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "Revision": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ZoneAccessPoint": { "type": "object", "properties": { "AccessPoint": { "$ref": "#/components/schemas/AccessPoint" }, "Device": { "$ref": "#/components/schemas/Int32IdName" } }, "additionalProperties": false }, "ZoneJsonPatchDocument": { "type": "object", "properties": { "Operations": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneOperation" }, "nullable": true } }, "additionalProperties": false }, "ZoneOperation": { "type": "object", "properties": { "value": { "nullable": true }, "path": { "type": "string", "nullable": true }, "op": { "type": "string", "nullable": true }, "from": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ZoneProblem": { "type": "object", "properties": { "Type": { "enum": [ "NoDeviceInZone", "DeviceWithoutSilentAlarm", "DeviceWithoutSilentAlarmLicense", "ZonalCodeCollision", "DeviceWithoutLimitFailedAccess", "DeviceWithoutLimitFailedAccessLicense", "Other" ], "type": "string" }, "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true } }, "additionalProperties": false }, "ZoneQueryResult": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Zone" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false } } } }