6.2 HTTP API verze 2

{ "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/v2/...`, 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)\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## 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 \"data\": {\r\n ...\r\n }\r\n}\r\n\r\n```\r\n\r\n\r\nEvery response is wrapped in the object \"data\". This arrangement offers the\r\nadvantage of sending metadata in the response, for instance:\r\n\r\n\r\n```json\r\n\r\n{\r\n \"meta\": {\r\n \"code\": 200\r\n },\r\n \"data\": {\r\n ...\r\n },\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`.\r\n", "version": "v2" }, "paths": { "/api/v2/AccessRules": { "get": { "tags": [ "AccessRules", "UserManager", "Admin", "AccessManager" ], "description": "Returns a list of access rules.", "responses": { "200": { "description": "The list of access rules", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRulesDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "description": "Creates a new access rule.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRulesDto" } } } }, "responses": { "200": { "description": "The detail of created access rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRulesDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/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": { "$ref": "#/components/schemas/AccessRulesDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/AccessRules/{ruleId}": { "get": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "description": "Returns a detail of the access rule.", "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The detail of the access rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRulesDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "description": "Performs a change of the access rule.", "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRulesDto" } } } }, "responses": { "200": { "description": "The detail of the access rule", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRulesDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "AccessRules", "Admin", "AccessManager" ], "description": "Deletes the access rule.", "parameters": [ { "name": "ruleId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRulesDto" } } } }, "responses": { "204": { "description": "The access rule has been deleted" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/areas": { "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns a list of anti-passback areas.", "responses": { "200": { "description": "The list of anti-passback areas", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Antipassback", "Admin" ], "description": "Creates a new anti-passback area.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDto" } } } }, "responses": { "200": { "description": "The detail of created anti-passback area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/areas/{areaId}": { "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns the anti-passback area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The anti-passback area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Antipassback", "Admin" ], "description": "Updates the anti-passback area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDto" } } } }, "responses": { "200": { "description": "The anti-passback area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Antipassback", "Admin" ], "description": "Deletes the anti-passback area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDto" } } } }, "responses": { "204": { "description": "The anti-passback area has been deleted" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/devices": { "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns a list of access devices.", "responses": { "200": { "description": "The list of access devices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDeviceDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/areas/{areaId}/devices/{deviceId}": { "put": { "tags": [ "Antipassback", "Admin" ], "description": "Updates the access device of the anti-passback area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDeviceDto" } } } }, "responses": { "200": { "description": "The access device of the anti-passback area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDeviceDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns the access device of the anti-passback area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The access device of the anti-passback area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDeviceDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/areas/{areaId}/devices": { "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns the access device list of the anti-passback area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The access device list of the anti-passback area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDeviceDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Antipassback", "Admin" ], "description": "Add access devices to the anti-passback area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } } }, "responses": { "200": { "description": "The anti-passback area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Antipassback", "Admin" ], "description": "Remove access devices from the anti-passback area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } } }, "responses": { "200": { "description": "The access device list of the anti-passback area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/setting": { "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns the anti-passback setting.", "responses": { "200": { "description": "The anti-passback setting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AntiPassbackSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Antipassback", "Admin" ], "description": "Updates the anti-passback setting.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AntiPassbackSettingDto" } } } }, "responses": { "200": { "description": "The anti-passback setting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AntiPassbackSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/excluded": { "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns the list of groups and users excluded from anti-passback mechanism.", "responses": { "200": { "description": "The list of groups and users excluded from anti-passback mechanism", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExcludedItemDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Antipassback", "Admin" ], "description": "Exclude items (groups, users) from anti-passback mechanism.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExcludedItemDto" } } } } }, "responses": { "200": { "description": "The list of groups and users excluded from anti-passback mechanism", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExcludedItemDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Antipassback", "Admin" ], "description": "Remove items (groups, users) from exclusion from anti-passback mechanism.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExcludedItemDto" } } } } }, "responses": { "200": { "description": "The list of groups and users excluded from anti-passback mechanism", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExcludedItemDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/areas/{areaId}/blocked": { "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns the list of blocked users of the area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The list of blocked users of the area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlockedUserArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Antipassback", "Admin" ], "description": "Removes users from the list of blocked users of the area.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "responses": { "200": { "description": "The list of blocked Users of the area", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShortMemberDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/resets": { "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns the anti-passback reset objects.", "responses": { "200": { "description": "The list of anti-passback reset objects", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaResetDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Antipassback", "Admin" ], "description": "Updates anti-passback resets (insert, update and delete at once).", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AreaResetDto" } } } } }, "responses": { "200": { "description": "The anti-passback reset object list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaResetDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Antipassback/areas/{areaId}/issues": { "get": { "tags": [ "Antipassback", "Admin" ], "description": "Returns the anti-passback area issues.", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "The anti-passback area issues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AreaIssueDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/users/{userId}/attendance": { "get": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Returns the structured attendance data of the user within the current month.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "The structured attendance data of the user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/users/{userId}/attendance/{year}/{month}/appointments": { "get": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Returns the structured attendance data of the user within the month.", "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": "The structured attendance data of the user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/users/{userId}/appointments": { "post": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Creates a new user appointment.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentDto" } } } }, "responses": { "200": { "description": "Created user appointment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/users/{userId}/appointments/{appointmentId}": { "get": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Returns the user appointment.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appointmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "User appointment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Performs a change of the user appointment.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appointmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentDto" } } } }, "responses": { "200": { "description": "Edited user appointment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Deletes the user appointment.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "appointmentId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "User appointment has been deleted" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/users/{userId}/attendance/export.csv": { "put": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Performs an export of attendance data to a CSV file.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2AttendanceExportRequest" } } } }, "responses": { "200": { "description": "The attendance data as a CSV file" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/users/{userId}/attendance/export.pdf": { "put": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Performs an export of attendance data to a PDF file. There must be PdfConverter.exe running on the background.", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2AttendanceExportRequest" } } } }, "responses": { "200": { "description": "The attendance data as a PDF file" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/users/attendance/export.pdf": { "put": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Performs an export of attendance data to a PDF file. There must be PdfConverter.exe running on the background.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2AttendanceExportRequest" } } } }, "responses": { "200": { "description": "The attendance data as a PDF file" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/users/attendance/export.csv": { "put": { "tags": [ "Attendance", "Admin", "AttendanceManager" ], "description": "Performs an export of detailed attendance data to a CSV file. If there are users in the body, the detailed CSV is produced. If there are no users in the body, the summary CSV is produced.", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/V2AttendanceExportRequest" } } } }, "responses": { "200": { "description": "The attendance data as a CSV file" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/system/backup/run": { "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupRequest" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/system/backup/storage": { "get": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupStorageSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupStorageSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupStorageSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/system/backup/periodic": { "get": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeriodicBackupSettingV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeriodicBackupSettingV2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeriodicBackupSettingV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/system/restore/file": { "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/BackupInfoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/system/restore": { "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreRequest" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/system/restore/files": { "get": { "tags": [ "BackupAndRestore", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupFileListSingleResult" } } } }, "501": { "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" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/system/restore/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" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/system/import": { "put": { "tags": [ "BackupAndRestore", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportRequest" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/search": { "get": { "tags": [ "Basic" ], "description": "Search with higher default limit.", "parameters": [ { "name": "query", "in": "query", "description": "string to be searched for", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "optional limit", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Search result (default limit 30 items)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/search/suggestions": { "get": { "tags": [ "Basic" ], "description": "Search with low default limit.", "parameters": [ { "name": "query", "in": "query", "description": "string to be searched for", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "optional limit", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Search result (default limit 3 items)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/search/suggestions/accesslog": { "get": { "tags": [ "Basic" ], "description": "Search in the access log.", "parameters": [ { "name": "query", "in": "query", "description": "string to be searched for", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Search result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultAccessLogV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/search/suggestions/systemlog": { "get": { "tags": [ "Basic" ], "description": "Search in the system log.", "parameters": [ { "name": "query", "in": "query", "description": "string to be searched for", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Search result", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultSystemLogV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/search/suggestions/lockdown": { "get": { "tags": [ "Basic" ], "description": "Search for lockdown.", "parameters": [ { "name": "query", "in": "query", "description": "string to be searched for", "schema": { "type": "string" } }, { "name": "addedDevices", "in": "query", "description": "comma separated Ids of added devices", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Mixed types in array - sample: \r\n{\r\n \"data\":\r\n {\r\n \"lockdownables\":\r\n [\r\n {\r\n \"Id\": 3,\r\n \"Name\": \"Office A\",\r\n \"Pattern\": \"a\",\r\n \"Type\": \"Device\",\r\n \"Properties\":\r\n [\r\n {\r\n \"Name\": \"deviceName\",\r\n \"Value\": \"Office A\"\r\n } \r\n ]\r\n },\r\n {\r\n \"Id\": \"6bbad4de-0f4b-43af-b240-c135417195ed\",\r\n \"Name\": \"Entrance\",\r\n \"Type\": \"Zone\",\r\n \"Devices\":\r\n [\r\n {\r\n \"Id\": 1,\r\n \"Name\": \"Main entrance\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SearchResultLockdownV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/presence": { "get": { "tags": [ "Basic" ], "description": "Returns a list of present Users.", "responses": { "200": { "description": "The list of present users and their useful properties", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresenceDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies": { "get": { "tags": [ "Companies", "Admin", "DoorManager", "AccessManager", "UserManager", "VisitorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Companies", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}": { "get": { "tags": [ "Companies", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/zones": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Uid" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Uid" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "get": { "tags": [ "Companies", "Admin", "AccessManager" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/holidays": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/holidays/copy": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "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/HolidayDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/holidays/{holidayId}": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "holidayId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "holidayId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "holidayId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HolidayDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/attendancesetting": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/commonsetting": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/ldap/fields": { "get": { "tags": [ "Companies", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapFieldsV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/ldap": { "post": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettingDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/ldap/{settingId}": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "settingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "settingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettingDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/ldap/{settingId}/synchronize": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "settingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronizationStateDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "settingId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "string" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/ldap/test": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LdapSettingDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/import.csv": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "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" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/devices": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReducedDeviceDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/devices/{deviceId}/importUsers": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "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" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/sendTestMail": { "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTest" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/emailSettings": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettingsDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettingsDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettingsDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/defaultEmailSettings": { "get": { "tags": [ "Companies", "Admin" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailSettingsDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Companies/{companyId}/visitorManagerGroups": { "get": { "tags": [ "Companies", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "companyId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Dashboard/info": { "get": { "tags": [ "Dashboard" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntityCountsSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices": { "get": { "tags": [ "Devices", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoV2QueryResult" } } } }, "501": { "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/DeviceConfigurationDto" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "patch": { "tags": [ "Devices", "Admin" ], "description": "Multiple asynchronous devices activation/deactivation (according to IsEnabled property).", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/scannetwork": { "get": { "tags": [ "Devices", "Admin" ], "description": "Returns a list of Devices found in the network.", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/cleardirectory": { "delete": { "tags": [ "Devices", "Admin" ], "description": "Deletes the Device and clears entries from the device directory.", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/factoryreset": { "delete": { "tags": [ "Devices", "Admin" ], "description": "Deletes the Device and performs factory reset of removed device.", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/buttons/{buttonNumber}": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "buttonNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserId" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/keypad": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserVirtualNumberArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserVirtualNumberDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserVirtualNumberSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/keypad/{keypadId}": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "keypadId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserVirtualNumberSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "keypadId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserVirtualNumberDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/backup": { "put": { "tags": [ "Devices", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/backup": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackupDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/backup/download": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "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" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/restore": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatusDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/restore/{backupId}": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "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/JobStatusDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/synchronize": { "get": { "tags": [ "Devices", "Admin" ], "description": "Returns the state of synchronization.", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobStatusDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/password": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/password/generate": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/status": { "get": { "tags": [ "Devices", "Admin", "DoorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceStateDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/status": { "get": { "tags": [ "Devices", "Admin", "DoorManager" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceStateDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/replace": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/switches/{switchId}": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "switchId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchCapabilityDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Devices", "Admin", "DoorManager" ], "parameters": [ { "name": "deviceId", "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": { "$ref": "#/components/schemas/SwitchActivationRequestDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/holdopen": { "put": { "tags": [ "Devices", "Admin", "DoorManager" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "integer", "format": "int32" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BooleanSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/floors": { "get": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiftFloorDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/floors/{floorId}": { "put": { "tags": [ "Devices", "Admin" ], "parameters": [ { "name": "deviceId", "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/LiftFloorDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiftFloorDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/update": { "put": { "tags": [ "Devices", "Admin" ], "description": "Upgrades device firmware to version specified in the system.", "parameters": [ { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "The device upgrade has started successfully" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/firmware": { "put": { "tags": [ "Devices", "Admin" ], "description": "Uploads user provided firmware file to device.", "parameters": [ { "name": "deviceId", "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" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/{deviceId}/snapshots/{timestamp}": { "get": { "tags": [ "Devices", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "parameters": [ { "name": "deviceId", "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": { "$ref": "#/components/schemas/SnapshotArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/certificatesValidation": { "get": { "tags": [ "Devices", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceCertificatesValidationSingleResult" } } } }, "501": { "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" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Devices/ntpmode": { "get": { "tags": [ "Devices", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "enum": [ "None", "PushServers", "PushLocalServer" ], "type": "string" } } } }, "501": { "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" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/DeviceUpdate": { "get": { "tags": [ "DeviceUpdate", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceUpdateDataDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "DeviceUpdate", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmwareUpdateSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceUpdateDataDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/DeviceUpdate/firmware/{firmwareId}/current": { "put": { "tags": [ "DeviceUpdate", "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/FirmwareDeploymentV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "DeviceUpdate", "Admin" ], "parameters": [ { "name": "firmwareId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmwareDeploymentV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/DeviceUpdate/firmware/{firmwareId}/candidate/deploy": { "put": { "tags": [ "DeviceUpdate", "Admin" ], "parameters": [ { "name": "firmwareId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmwareDeploymentV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/DeviceUpdate/firmware/{firmwareId}/candidate/devicetest": { "put": { "tags": [ "DeviceUpdate", "Admin" ], "parameters": [ { "name": "firmwareId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/DeviceUpdate/firmware/{firmwareId}/candidate/releasenotes": { "get": { "tags": [ "DeviceUpdate", "Admin" ], "parameters": [ { "name": "firmwareId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseNotesSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Groups": { "get": { "tags": [ "Groups", "UserManager", "VisitorManager", "AttendanceManager", "Admin", "AccessManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Groups", "Admin", "AccessManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Groups/{groupId}": { "get": { "tags": [ "Groups", "UserManager", "Admin", "AccessManager" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Groups", "Admin", "AccessManager" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Groups", "Admin", "AccessManager" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Groups/{groupId}/members": { "put": { "tags": [ "Groups", "UserManager", "Admin", "AccessManager" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Uid" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Groups", "UserManager", "Admin", "AccessManager" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Uid" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "get": { "tags": [ "Groups", "UserManager", "Admin", "AccessManager" ], "parameters": [ { "name": "groupId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Lockdown/activate": { "put": { "tags": [ "Lockdown", "Admin", "DoorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LockdownRequest" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Lockdown/deactivate": { "put": { "tags": [ "Lockdown", "Admin", "DoorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LockdownRequest" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/login": { "get": { "tags": [ "Login" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginInfoDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginDataV2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginInfoDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/logout": { "put": { "tags": [ "Login" ], "responses": { "200": { "description": "Success" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/passwordreset": { "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetData" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/passwordresetverification": { "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordResetCodeData" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordTokenDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/setnewpassword": { "put": { "tags": [ "Login" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordSetRequest" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginInfoDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Notifications": { "get": { "tags": [ "Notifications", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Notifications", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Notifications/types": { "get": { "tags": [ "Notifications", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationEventArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Notifications/clear": { "put": { "tags": [ "Notifications", "Admin" ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Notifications/{notificationId}": { "get": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Notifications/{notificationId}/devices": { "put": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntId" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32IdNameSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntId" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Int32IdNameSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Notifications/{notificationId}/recipients": { "put": { "tags": [ "Notifications", "Admin" ], "parameters": [ { "name": "notificationId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecipientsDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/SignalR/topics": { "get": { "tags": [ "SignalR" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TopicDescriptionArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Snapshots/setting": { "get": { "tags": [ "Snapshots", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLogDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Snapshots", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLogDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLogDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Snapshots/setting/{camLogId}": { "get": { "tags": [ "Snapshots", "Admin" ], "parameters": [ { "name": "camLogId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLogDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Snapshots", "Admin" ], "parameters": [ { "name": "camLogId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLogDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLogDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Snapshots", "Admin" ], "parameters": [ { "name": "camLogId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamLogDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Snapshots/setting/eventtypes": { "get": { "tags": [ "Snapshots", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DoorStationEventTypeArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Snapshots/setting/{camLogId}/devices": { "get": { "tags": [ "Snapshots", "Admin" ], "parameters": [ { "name": "camLogId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Snapshots", "Admin" ], "parameters": [ { "name": "camLogId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Snapshots", "Admin" ], "parameters": [ { "name": "camLogId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceConfigurationDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/attendance": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceModeSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceModeSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttendanceModeSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/license": { "get": { "tags": [ "System", "Admin", "UserManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseInfoDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/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/LicenseInfoDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/license/features": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseFeaturesDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/license/activatebasic": { "put": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseInfoDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/license/renew": { "put": { "tags": [ "System", "Admin" ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/logs/attendance": { "get": { "tags": [ "System", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessEventDtoV2V2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/logs/attendance/export.csv": { "get": { "tags": [ "System", "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" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/logs/system": { "get": { "tags": [ "System", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemLogDataV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/logs/system/export.csv": { "get": { "tags": [ "System", "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" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/smtp": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailerSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailerSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailerSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/smtp/sendtestemail": { "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MailTest" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/smtp/status": { "get": { "tags": [ "System", "Admin", "UserManager", "VisitorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmtpStatusDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/http": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/zones": { "get": { "tags": [ "System", "Admin", "AccessManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/visitors": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorsSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorsSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorsSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/updatesetting": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcomUpdateSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcomUpdateSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcomUpdateSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/update/status": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateStepV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/update/check": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateStepV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/update/download": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateStepV2SingleResult" } } } }, "501": { "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/SystemUpdateStepV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/update/run": { "put": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemUpdateStepV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/licenseagreement": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseAgreementSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseAgreementSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseAgreementSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/mobilekey": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileKeySettingsDto" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileKeySettingsDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileKeySettingsDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/mobilekey/keys/{ordinal}": { "delete": { "tags": [ "System", "Admin" ], "parameters": [ { "name": "ordinal", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileEncryptionKeyDtoV2ArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/mobilekey/keys": { "post": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileEncryptionKeyDtoV2ArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/data/synchronization/import.csv": { "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/SynchronizationStatusDtoV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/data/synchronization/run": { "put": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronizationStatusDtoV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/data/synchronization": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronizationSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronizationSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronizationSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/data/synchronization/status": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SynchronizationStatusDtoV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/verification": { "put": { "tags": [ "System" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptchaVerificationV2" } } } }, "responses": { "204": { "description": "No Content" }, "423": { "description": "Client Error" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/verification/loadimage": { "put": { "tags": [ "System" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CaptchaVerificationV2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificationImageDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/info": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SystemInfoDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/diagnostic/package": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticStatusDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/diagnostic/package/create": { "put": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticStatusDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/diagnostic/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" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/diagnostic/statistics": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatisticsSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/compatible": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncompatibleFirmwareV2V2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncompatibleFirmwareV2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncompatibleFirmwareV2V2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/compatible/versions": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncompatibleFirmwareV2V2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/readers": { "get": { "tags": [ "System" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadersSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadersSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadersSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/presence": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresenceSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresenceSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresenceSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/spaceusage": { "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/DiskUsageReportDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/loglifetime": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiskManagementSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiskManagementSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiskManagementSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/ssh": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SshServiceStateSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SshServiceState" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SshServiceStateSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/rootPassword": { "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChange" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChangeSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/datetime": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateAndTimeSettingSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateAndTimeSetting" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateAndTimeSettingSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/datetime/timezone": { "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeZoneId" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DateAndTimeSettingSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/network": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSettingsSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSettings" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSettingsSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/network/proxy": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxySettingSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxySetting" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProxySettingSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/System/securecardssetting": { "get": { "tags": [ "System", "Admin" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecureCardKeyInfoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "System", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecureCardKeysImport" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecureCardKeysSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "System", "Admin" ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/TimeProfiles": { "get": { "tags": [ "TimeProfiles", "UserManager", "Admin", "AccessManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfileDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfileDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfileDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/TimeProfiles/{timeProfileId}": { "get": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfileDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfileDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfileDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfileDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/TimeProfiles/{timeProfileId}/days": { "get": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeProfileDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/TimeProfiles/{timeProfileId}/days/{dayOfWeek}": { "get": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dayOfWeek", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DayOfWeekDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dayOfWeek", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Day" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DayOfWeekDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/TimeProfiles/{timeProfileId}/days/{dayOfWeek}/intervals": { "get": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dayOfWeek", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntervalDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dayOfWeek", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntervalDto" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntervalDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/TimeProfiles/{timeProfileId}/days/{dayOfWeek}/intervals/{intervalId}": { "get": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dayOfWeek", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "intervalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntervalDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dayOfWeek", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "intervalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntervalDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntervalDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "TimeProfiles", "Admin", "AccessManager" ], "parameters": [ { "name": "timeProfileId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "dayOfWeek", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "intervalId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntervalDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}": { "get": { "tags": [ "Users", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users": { "get": { "tags": [ "Users", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserDtoSingleResult" } } } }, "501": { "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/UserDto" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/restrictedAccess": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserBulkRestrictedAccess" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/attendanceMonitoring": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/groups": { "put": { "tags": [ "Users", "AccessManager", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Uid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "AccessManager", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Uid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupDtoArraySingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/cards": { "post": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/cards/{cardId}": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CardDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/mobilekey": { "get": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPairingStatusSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/mobilekey/{authId}": { "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "authId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPairingStatusSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/mobilekey/pairing/start": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPairingStatusSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/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" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/mobilekey/pairing/stop": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPairingStatusSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/mobilekey/pairing/dongle": { "get": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileKeyCredentialsV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileKeyDonglePairing" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPairingStatusSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/mobilekey/pairing/sendmail": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SendPairingMailDto" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/fingerprints": { "post": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FingerprintDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FingerprintDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/fingerprints/{fingerprintId}": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fingerprintId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FingerprintDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FingerprintDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fingerprintId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FingerprintDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/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/UserDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/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/UserDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/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" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/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" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/codes": { "post": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/codes/{codeId}": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "codeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "codeId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodeDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/phonenumbers": { "post": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/phonenumbers/{phoneNumberId}": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "phoneNumberId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "phoneNumberId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhoneNumberDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/settings": { "get": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSettingDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/right": { "get": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Users", "Admin" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesV2" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RolesV2SingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/password": { "put": { "tags": [ "Users" ], "parameters": [ { "name": "userId", "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/UserDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/onetimepassword": { "put": { "tags": [ "Users", "Admin" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PasswordChange" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/generatepassword": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/restrictedaccess": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRestriction" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessRestrictionSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/avatar": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "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" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Users/{userId}/email": { "put": { "tags": [ "Users", "Admin", "UserManager", "VisitorManager" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors": { "get": { "tags": [ "Visitor", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorV2DtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Visitor", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorV2Dto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors/{id}": { "get": { "tags": [ "Visitor", "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/VisitorV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Visitor", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorV2Dto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Visitor", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorV2Dto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors/{id}/groups": { "put": { "tags": [ "Visitor", "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/Uid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdNameSingleResult" } } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Visitor", "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/Uid" } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdNameSingleResult" } } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors/{id}/pin": { "post": { "tags": [ "Visitor", "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/VisitorV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors/{id}/qrcode": { "post": { "tags": [ "Visitor", "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/VisitorV2DtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors/{id}/qr.png": { "get": { "tags": [ "Visitor", "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" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors/{id}/qr.svg": { "get": { "tags": [ "Visitor", "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" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors/{id}/email": { "put": { "tags": [ "Visitor", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors/cards": { "get": { "tags": [ "VisitorCards", "Admin", "AccessManager", "UserManager", "VisitorManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCardDtoV2QueryResult" } } } }, "501": { "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/VisitorCardDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCardDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/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/VisitorCardDtoSingleResult" } } } }, "501": { "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/VisitorCardDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCardDtoSingleResult" } } } }, "501": { "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" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VisitorCardDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/visitors/cards/find": { "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/VisitorCardDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Zones": { "get": { "tags": [ "Zones", "Admin", "AccessManager", "UserManager", "VisitorManager", "DoorManager", "AttendanceManager" ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "post": { "tags": [ "Zones", "Admin" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneData" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Zones/{zoneId}": { "get": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "zoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "put": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "zoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneDto" } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneDtoSingleResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "zoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZoneDto" } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Zones/{zoneId}/companies": { "put": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "zoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntId" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "delete": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "zoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IntId" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "get": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "zoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Zones/{zoneId}/devices": { "put": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "zoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneAccessPoint" } } } } }, "responses": { "204": { "description": "No Content" }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } }, "get": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "zoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceDtoV2QueryResult" } } } }, "501": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResult" } } } } } } }, "/api/v2/Zones/{zoneId}/devices/{deviceId}": { "delete": { "tags": [ "Zones", "Admin" ], "parameters": [ { "name": "zoneId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "deviceId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "No Content" }, "501": { "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 }, "AccessEventDtoV2": { "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/AccessLogPersonDtoV2" }, "Device": { "$ref": "#/components/schemas/AccessLogDeviceDtoV2" }, "ZoneEntered": { "$ref": "#/components/schemas/AccessLogZoneDtoV2" }, "ZoneExited": { "$ref": "#/components/schemas/AccessLogZoneDtoV2" }, "Credentials": { "$ref": "#/components/schemas/AccessLogCredentialsDtoV2" }, "Detail": { "type": "string", "nullable": true }, "Snapshot": { "$ref": "#/components/schemas/LogSnapshotDto" }, "CreatedTimestamp": { "type": "string", "nullable": true }, "Direction": { "type": "string", "nullable": true }, "AccessPoint": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "AccessEventDtoV2V2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccessEventDtoV2" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AccessLogCredentialsDtoV2": { "type": "object", "properties": { "Pin": { "type": "string", "nullable": true }, "QrCode": { "type": "string", "nullable": true }, "Card": { "type": "string", "nullable": true }, "FingerPrint": { "type": "string", "nullable": true }, "Rex": { "type": "string", "nullable": true }, "Bluetooth": { "type": "string", "nullable": true }, "Remote": { "type": "string", "nullable": true }, "LicensePlate": { "type": "string", "nullable": true }, "Credentials": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccessLogDeviceDtoV2": { "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 }, "AccessLogPersonDtoV2": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "PhoneNumber": { "type": "string", "nullable": true }, "CurrentName": { "type": "string", "nullable": true }, "CompanyName": { "type": "string", "nullable": true }, "CanSeeDetail": { "type": "boolean" }, "IsVisitor": { "type": "boolean" } }, "additionalProperties": false }, "AccessLogZoneDtoV2": { "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" }, "AccessRestriction": { "type": "object", "properties": { "IsFromEnabled": { "type": "boolean" }, "IsToEnabled": { "type": "boolean" }, "FromDate": { "type": "string", "nullable": true }, "FromTime": { "type": "string", "nullable": true }, "ToDate": { "type": "string", "nullable": true }, "ToTime": { "type": "string", "nullable": true }, "ValidFrom": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true }, "ValidTo": { "type": "string", "format": "date-time", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "AccessRestrictionSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AccessRestriction" } }, "additionalProperties": false }, "AccessRulesDto": { "type": "object", "properties": { "Group": { "$ref": "#/components/schemas/GuidIdName" }, "Zone": { "$ref": "#/components/schemas/GuidIdName" }, "TimeProfile": { "$ref": "#/components/schemas/GuidIdName" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccessRulesDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRulesDto" }, "nullable": true } }, "additionalProperties": false }, "AccessRulesDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AccessRulesDto" } }, "additionalProperties": false }, "AccessRulesDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AccessRulesDto" }, "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 }, "AcomUpdateSettingDto": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Beta": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AcomUpdateSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AcomUpdateSettingDto" } }, "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" }, "AntiPassbackSettingDto": { "type": "object", "properties": { "SendEmailToUser": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AntiPassbackSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AntiPassbackSettingDto" } }, "additionalProperties": false }, "ApPropertyDto": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "SerialNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AppointmentDto": { "type": "object", "properties": { "Hours": { "type": "number", "format": "double" }, "Id": { "type": "integer", "format": "int32" }, "IsEdited": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Date": { "type": "string", "nullable": true }, "From": { "type": "string", "nullable": true }, "To": { "type": "string", "nullable": true }, "Subject": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AppointmentDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AppointmentDto" } }, "additionalProperties": false }, "AreaDeviceDto": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "APEntrance": { "type": "integer", "format": "int32" }, "APExit": { "type": "integer", "format": "int32" }, "AP0Properties": { "type": "array", "items": { "$ref": "#/components/schemas/ApPropertyDto" }, "nullable": true }, "AP1Properties": { "type": "array", "items": { "$ref": "#/components/schemas/ApPropertyDto" }, "nullable": true }, "IPAddress": { "type": "string", "nullable": true }, "SerialNumber": { "type": "string", "nullable": true }, "Locked": { "type": "boolean", "nullable": true }, "IsConfigured": { "type": "boolean" }, "HasAccessPoint": { "type": "boolean" } }, "additionalProperties": false }, "AreaDeviceDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AreaDeviceDto" }, "nullable": true } }, "additionalProperties": false }, "AreaDeviceDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AreaDeviceDto" } }, "additionalProperties": false }, "AreaDto": { "type": "object", "properties": { "ApbMode": { "$ref": "#/components/schemas/Mode" }, "ApbTimeout": { "type": "integer", "format": "int32" }, "Blocked": { "nullable": true }, "CurrentOccupancy": { "type": "integer", "format": "int32" }, "Direction": { "type": "integer", "format": "int32" }, "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/AreaDeviceDto" }, "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "IsActive": { "type": "boolean" }, "Issues": { "type": "array", "items": { "$ref": "#/components/schemas/AreaIssueDto" }, "nullable": true }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "OccupancyLimit": { "type": "integer", "format": "int32" }, "OccupancyMode": { "$ref": "#/components/schemas/Mode" } }, "additionalProperties": false }, "AreaDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AreaDto" } }, "additionalProperties": false }, "AreaDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AreaDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "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 }, "AreaIssueDto": { "type": "object", "properties": { "Type": { "$ref": "#/components/schemas/IssueType" }, "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/AreaIssueDeviceDto" }, "nullable": true } }, "additionalProperties": false }, "AreaIssueDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AreaIssueDto" }, "nullable": true } }, "additionalProperties": false }, "AreaResetDto": { "type": "object", "properties": { "ResetTime": { "type": "string", "nullable": true }, "DaysOfWeek": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true } }, "additionalProperties": false }, "AreaResetDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AreaResetDto" }, "nullable": true } }, "additionalProperties": false }, "AttendanceDto": { "type": "object", "properties": { "PeriodHours": { "type": "string", "nullable": true }, "WorkedHours": { "type": "string", "nullable": true }, "WorkingHours": { "type": "string", "nullable": true }, "Balance": { "type": "string", "nullable": true }, "Days": { "type": "array", "items": { "$ref": "#/components/schemas/DaysDto" }, "nullable": true } }, "additionalProperties": false }, "AttendanceDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AttendanceDto" } }, "additionalProperties": false }, "AttendanceModeSettingDto": { "type": "object", "properties": { "IsAttendanceSpecifyingDirection": { "type": "boolean" }, "TrackAllDevices": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AttendanceModeSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AttendanceModeSettingDto" } }, "additionalProperties": false }, "AttendanceSettingDto": { "type": "object", "properties": { "WorkingDays": { "type": "array", "items": { "$ref": "#/components/schemas/BusinessDayDto" }, "nullable": true }, "WorkingHoursFrom": { "type": "string", "format": "date-span" }, "WorkingHoursTo": { "type": "string", "format": "date-span" }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "AttendanceSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/AttendanceSettingDto" } }, "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 }, "AudioTestResultV2": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "<ul><li>0 - <i>Passed</i></li>\n<li>1 - <i>No</i></li>\n<li>2 - <i>Failed</i></li>\n<li>3 - <i>Unknown</i></li>\n</ul>", "format": "int32" }, "AudioTestResultV2StateOfDto": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/AudioTestResultV2" }, "Time": { "type": "string", "format": "date-time", "nullable": true }, "FailureReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BackupDto": { "type": "object", "properties": { "SoftwareVersion": { "type": "string", "nullable": true }, "Modified": { "type": "string", "format": "date-time" }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "BackupDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BackupDto" }, "nullable": true } }, "additionalProperties": false }, "BackupFileList": { "type": "object", "properties": { "BackupFiles": { "type": "array", "items": { "$ref": "#/components/schemas/BackupInfo" }, "nullable": true }, "SmbError": { "type": "boolean" } }, "additionalProperties": false }, "BackupFileListSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BackupFileList" } }, "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 }, "BackupInfoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BackupInfo" } }, "additionalProperties": false }, "BackupRequest": { "type": "object", "properties": { "Password": { "type": "string", "nullable": true } }, "additionalProperties": false }, "BackupStorageSettingDto": { "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 }, "Protocol": { "$ref": "#/components/schemas/ProtocolVersion" } }, "additionalProperties": false }, "BackupStorageSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/BackupStorageSettingDto" } }, "additionalProperties": false }, "BlockedUser": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "IsVisitor": { "type": "boolean" } }, "additionalProperties": false }, "BlockedUserArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/BlockedUser" }, "nullable": true } }, "additionalProperties": false }, "BooleanSingleResult": { "type": "object", "properties": { "data": { "type": "boolean" } }, "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 }, "BusinessDayDto": { "type": "object", "properties": { "Ordinal": { "type": "integer", "format": "int32" }, "IsBusinessDay": { "type": "boolean" }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "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 }, "ButtonDto": { "type": "object", "properties": { "Button": { "type": "integer", "format": "int32" }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "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 }, "CamLogDto": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" }, "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" } }, "additionalProperties": false }, "CamLogDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CamLogDto" } }, "additionalProperties": false }, "CamLogDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CamLogDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CandidateFwDto": { "type": "object", "properties": { "Version": { "type": "string", "nullable": true }, "IsCompatible": { "type": "boolean" }, "IsAllowed": { "type": "boolean" } }, "additionalProperties": false }, "CaptchaVerificationV2": { "type": "object", "properties": { "Key": { "type": "string", "nullable": true }, "VerificationText": { "type": "string", "nullable": true } }, "additionalProperties": false }, "CardDto": { "type": "object", "properties": { "Identification": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CardDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CardDto" } }, "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 }, "CodeDto": { "type": "object", "properties": { "Ordinal": { "type": "integer", "format": "int32" }, "SwitchCode": { "type": "string", "nullable": true }, "Collisions": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CodeDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CodeDto" } }, "additionalProperties": false }, "ColumnItem": { "type": "object", "properties": { "Value": { "type": "integer", "format": "int32" } }, "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 }, "CompanyDevice": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Status": { "enum": [ "Unknown", "CertificateInvalid", "Inaccessible", "LoginFailed", "Online", "Disabled", "Incompatible" ], "type": "string" } }, "additionalProperties": false }, "CompanyDto": { "type": "object", "properties": { "AttendanceSetting": { "$ref": "#/components/schemas/AttendanceSettingDto" }, "CommonSetting": { "$ref": "#/components/schemas/CompanySettingDto" }, "DefaultVisitorGroups": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDevice" }, "nullable": true }, "Holidays": { "type": "array", "items": { "$ref": "#/components/schemas/HolidayDto" }, "nullable": true }, "LdapEnabled": { "type": "boolean" }, "LdapSettings": { "type": "array", "items": { "$ref": "#/components/schemas/LdapSettingDto" }, "nullable": true }, "Lockdown": { "$ref": "#/components/schemas/LockdownStateDto" }, "MobileKeySettings": { "$ref": "#/components/schemas/CredentialSettingsDto" }, "VisitorManagerGroups": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "ZonesShortList": { "type": "string", "nullable": true }, "EmailSettings": { "$ref": "#/components/schemas/EmailSettings" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CompanyDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanyDto" } }, "additionalProperties": false }, "CompanyDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CompanySettingDto": { "type": "object", "properties": { "FirstDayOfWeek": { "type": "string", "nullable": true }, "Localization": { "$ref": "#/components/schemas/LanguageV2" }, "WeekViewMode": { "type": "integer", "format": "int32" }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CompanySettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/CompanySettingDto" } }, "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 }, "CredentialSettingsDto": { "type": "object", "properties": { "PairingDevices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "ValidityPeriod": { "maximum": 14400, "minimum": 10, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CurrentFwDto": { "type": "object", "properties": { "Version": { "type": "string", "nullable": true }, "FailedUpdates": { "type": "integer", "format": "int32" }, "PendingUpdates": { "type": "integer", "format": "int32" }, "TotalUpdates": { "type": "integer", "format": "int32" }, "IsCompatible": { "type": "boolean" }, "IsAllowed": { "type": "boolean" } }, "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 }, "DateAndTimeSettingSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DateAndTimeSetting" } }, "additionalProperties": false }, "Day": { "type": "object", "properties": { "Enabled": { "type": "boolean" } }, "additionalProperties": false }, "DayDto": { "type": "object", "properties": { "Order": { "type": "integer", "format": "int32" }, "Id": { "type": "integer", "format": "int32" }, "Date": { "type": "string", "nullable": true }, "Hours": { "type": "number", "format": "double" }, "DayBalance": { "type": "number", "format": "double" }, "From": { "type": "string", "nullable": true }, "To": { "type": "string", "nullable": true }, "Subject": { "type": "string", "nullable": true }, "Holiday": { "type": "boolean" }, "IsEdited": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "ModifiedBy": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DayIntervals": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Intervals": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Interval" }, "nullable": true } }, "additionalProperties": false }, "DayOfWeekDto": { "type": "object", "properties": { "DayOfWeek": { "type": "integer", "format": "int32" }, "Enabled": { "type": "boolean" }, "Intervals": { "type": "array", "items": { "$ref": "#/components/schemas/IntervalDto" }, "nullable": true }, "TimeProfile": { "$ref": "#/components/schemas/ProfileIdDto" } }, "additionalProperties": false }, "DayOfWeekDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DayOfWeekDto" } }, "additionalProperties": false }, "DaysDto": { "type": "object", "properties": { "Appointments": { "type": "array", "items": { "$ref": "#/components/schemas/DayDto" }, "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 }, "DeviceCertificatesValidationSingleResult": { "type": "object", "properties": { "data": { "enum": [ "none", "chain", "fingerprint" ], "type": "string" } }, "additionalProperties": false }, "DeviceChangePayload": { "type": "object", "properties": { "DeviceId": { "type": "integer", "format": "int32" }, "State": { "type": "string", "nullable": true } }, "additionalProperties": false }, "DeviceConfigurationDto": { "type": "object", "properties": { "SerialNumber": { "type": "string", "nullable": true }, "IPAddress": { "type": "string", "nullable": true }, "MACAddress": { "type": "string", "nullable": true }, "Port": { "type": "integer", "format": "int32" }, "Login": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true }, "ProductName": { "type": "string", "nullable": true }, "DevType": { "type": "string", "nullable": true }, "IsEnabled": { "type": "boolean" }, "SoftwareVersion": { "type": "string", "nullable": true }, "ButtonCount": { "type": "integer", "format": "int32" }, "Buttons": { "type": "array", "items": { "$ref": "#/components/schemas/ButtonDto" }, "nullable": true }, "Keypad": { "type": "array", "items": { "$ref": "#/components/schemas/UserVirtualNumberDto" }, "nullable": true }, "Features": { "type": "string", "nullable": true }, "Ap0Zone": { "$ref": "#/components/schemas/GuidIdName" }, "Ap1Zone": { "$ref": "#/components/schemas/GuidIdName" }, "LiftModules": { "type": "array", "items": { "$ref": "#/components/schemas/LiftModule" }, "nullable": true }, "LiftFloors": { "type": "array", "items": { "$ref": "#/components/schemas/LiftFloorDto" }, "nullable": true }, "HasAccessControl": { "type": "boolean" }, "HasDoorControl": { "type": "boolean" }, "Display": { "type": "boolean" }, "KeyBoard": { "type": "integer", "format": "int32" }, "Camera": { "type": "boolean" }, "HasRexButton": { "type": "boolean" }, "DoorSwitch": { "type": "integer", "format": "int32" }, "HasLiftControl": { "type": "boolean" }, "LiftEnabled": { "type": "boolean" }, "HasHiSecFeatures": { "type": "boolean" }, "IsSupportedFirmware": { "type": "boolean" }, "IsAllowedFirmware": { "type": "boolean" }, "IsLicensedDevice": { "type": "boolean" }, "HasBackup": { "type": "boolean" }, "LastBackup": { "$ref": "#/components/schemas/BackupDto" }, "BackupState": { "$ref": "#/components/schemas/JobStatusDto" }, "RestoreState": { "$ref": "#/components/schemas/JobStatusDto" }, "UploadState": { "$ref": "#/components/schemas/JobStatusDto" }, "IsInSystem": { "type": "boolean" }, "Status": { "$ref": "#/components/schemas/StatusDto" }, "Lockdown": { "$ref": "#/components/schemas/LockdownStateDto" }, "Ap0Modules": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareModule" }, "nullable": true }, "Ap1Modules": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareModule" }, "nullable": true }, "HasDisplayFolderImages": { "type": "boolean" }, "HasVirtualNumbers": { "type": "boolean" }, "AttendanceEnabled": { "type": "boolean" }, "CamLogSupported": { "type": "boolean" }, "IsFirmwareLocked": { "type": "boolean" }, "IsAnsweringUnit": { "type": "boolean" }, "IsIndoorTouch": { "type": "boolean" }, "IsIndoorTouch2": { "type": "boolean" }, "IsLockdownable": { "type": "boolean" }, "HasSwitchControl": { "type": "boolean" }, "Problems": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceProblemDto" }, "nullable": true }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Type": { "type": "string", "nullable": true, "readOnly": true }, "IsLockdownActiveAndConfirmed": { "type": "boolean", "readOnly": true }, "IsLockdownUnConfirmed": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "DeviceConfigurationDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" }, "nullable": true } }, "additionalProperties": false }, "DeviceConfigurationDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeviceConfigurationDto" } }, "additionalProperties": false }, "DeviceConfigurationDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceConfigurationDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DeviceDto": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "AccessPoint": { "$ref": "#/components/schemas/AccessPoint" }, "LiftEnabled": { "type": "boolean" }, "HasLiftControl": { "type": "boolean" }, "Status": { "$ref": "#/components/schemas/StatusDto" }, "IsLockdownable": { "type": "boolean" }, "Modules": { "type": "array", "items": { "$ref": "#/components/schemas/HardwareModule" }, "nullable": true }, "HasRexButton": { "type": "boolean" }, "LiftFloors": { "nullable": true } }, "additionalProperties": false }, "DeviceDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DeviceLockdownState": { "type": "object", "properties": { "State": { "enum": [ "Unknown", "Normal", "Lockdown", "PartialLockdown" ], "type": "string" }, "Confirmed": { "type": "boolean" }, "Overview": { "$ref": "#/components/schemas/LockdownOverview" } }, "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 }, "DeviceProblemDto": { "type": "object", "properties": { "Type": { "$ref": "#/components/schemas/DeviceProblemType" }, "AdditionalInfo": { "type": "string", "nullable": true }, "UserId": { "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false }, "DeviceProblemType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 100 ], "type": "integer", "description": "<ul><li>0 - <i>LiftLicenseLost</i></li>\n<li>1 - <i>LiftModuleDisabled</i></li>\n<li>2 - <i>LiftModuleDisconnected</i></li>\n<li>3 - <i>FirmwareUpdateFailed</i></li>\n<li>4 - <i>FirmwareUpdateRetriesFailed</i></li>\n<li>5 - <i>MaximumParallelCallReached</i></li>\n<li>6 - <i>MaximumTreePathReached</i></li>\n<li>100 - <i>Other</i></li>\n</ul>", "format": "int32" }, "DeviceStateDto": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "IsOnline": { "type": "boolean" }, "Status": { "$ref": "#/components/schemas/StatusDto" }, "Name": { "type": "string", "nullable": true }, "SerialNumber": { "type": "string", "nullable": true }, "IsLicensedDevice": { "type": "boolean" }, "IPAddress": { "type": "string", "nullable": true }, "MACAddress": { "type": "string", "nullable": true }, "UpTime": { "type": "integer", "format": "int32" }, "Sip1": { "$ref": "#/components/schemas/SipRegistrationV2StateOfDto" }, "Sip2": { "$ref": "#/components/schemas/SipRegistrationV2StateOfDto" }, "AudioLoopTest": { "$ref": "#/components/schemas/AudioTestResultV2StateOfDto" }, "TamperSwitch": { "$ref": "#/components/schemas/TriggerV2StateOfDto" }, "Door": { "$ref": "#/components/schemas/DoorV2StateOfDto" }, "Out": { "$ref": "#/components/schemas/RelayV2StateOfDto" }, "SoftwareVersion": { "type": "string", "nullable": true }, "LiftModules": { "type": "array", "items": { "$ref": "#/components/schemas/LiftModule" }, "nullable": true }, "Lockdown": { "$ref": "#/components/schemas/LockdownStateDto" }, "HeldOpen": { "type": "boolean" }, "HoldOpenUntil": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DeviceStateDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/DeviceStateDto" }, "nullable": true } }, "additionalProperties": false }, "DeviceStateDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeviceStateDto" } }, "additionalProperties": false }, "DeviceUpdateDataDto": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Firmware": { "type": "array", "items": { "$ref": "#/components/schemas/FirmwareDeploymentV2" }, "nullable": true }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DeviceUpdateDataDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DeviceUpdateDataDto" } }, "additionalProperties": false }, "DiagnosticFileStatus": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "<ul><li>0 - <i>None</i></li>\n<li>1 - <i>Creating</i></li>\n<li>2 - <i>Exists</i></li>\n<li>3 - <i>Failed</i></li>\n</ul>", "format": "int32" }, "DiagnosticStatusCreatedDto": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/DiagnosticFileStatus" }, "Created": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DiagnosticStatusDto": { "type": "object", "properties": { "DiagnosticStatus": { "$ref": "#/components/schemas/DiagnosticStatusCreatedDto" } }, "additionalProperties": false }, "DiagnosticStatusDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DiagnosticStatusDto" } }, "additionalProperties": false }, "DiskManagementSettingDto": { "required": [ "AccessLog", "CamLog", "LocalBackup", "SystemLog" ], "type": "object", "properties": { "AccessLog": { "$ref": "#/components/schemas/LogLifespan" }, "SystemLog": { "$ref": "#/components/schemas/LogLifespan" }, "CamLog": { "$ref": "#/components/schemas/LogLifespan" }, "LocalBackup": { "$ref": "#/components/schemas/LogLifespan" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DiskManagementSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DiskManagementSettingDto" } }, "additionalProperties": false }, "DiskUsageOldestLogDto": { "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 }, "LocalBackup": { "type": "string", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "DiskUsagePercentDto": { "type": "object", "properties": { "Timestamp": { "type": "string", "format": "date-time" }, "AccessLogs": { "type": "number", "format": "double", "readOnly": true }, "SystemLogs": { "type": "number", "format": "double", "readOnly": true }, "CamLogs": { "type": "number", "format": "double", "readOnly": true }, "LocalBackups": { "type": "number", "format": "double", "readOnly": true }, "Rest": { "type": "number", "format": "double", "readOnly": true } }, "additionalProperties": false }, "DiskUsageReportDto": { "type": "object", "properties": { "Latest": { "$ref": "#/components/schemas/DiskUsagePercentDto" }, "OldestLog": { "$ref": "#/components/schemas/DiskUsageOldestLogDto" }, "History": { "type": "array", "items": { "$ref": "#/components/schemas/DiskUsagePercentDto" }, "nullable": true }, "ShowUsageWaring": { "type": "boolean" } }, "additionalProperties": false }, "DiskUsageReportDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/DiskUsageReportDto" } }, "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 }, "DoorStationEventTypeArraySingleResult": { "type": "object", "properties": { "data": { "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" }, "nullable": true } }, "additionalProperties": false }, "DoorV2": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "<ul><li>0 - <i>Closed</i></li>\n<li>1 - <i>Opened</i></li>\n<li>2 - <i>TooLong</i></li>\n<li>3 - <i>Unauthorized</i></li>\n<li>4 - <i>Unknown</i></li>\n</ul>", "format": "int32" }, "DoorV2StateOfDto": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/DoorV2" }, "Time": { "type": "string", "format": "date-time", "nullable": true }, "FailureReason": { "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 }, "EmailSettingsDto": { "required": [ "HeaderBackgroundColor", "HeaderTextColor" ], "type": "object", "properties": { "HeaderBackgroundColor": { "minLength": 1, "type": "string" }, "HeaderTextColor": { "minLength": 1, "type": "string" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Templates": { "$ref": "#/components/schemas/TemplatesDto" } }, "additionalProperties": false }, "EmailSettingsDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EmailSettingsDto" } }, "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 }, "EntityCountsSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/EntityCounts" } }, "additionalProperties": false }, "ExcludedItemDto": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ExcludedItemDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ExcludedItemDto" }, "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 }, "FingerprintDto": { "type": "object", "properties": { "Position": { "maximum": 9, "minimum": 0, "type": "integer", "format": "int32" }, "Template": { "type": "string", "nullable": true }, "IsOpenDoor": { "type": "boolean" }, "IsSilentAlarm": { "type": "boolean" }, "IsAutomationFunction1": { "type": "boolean" }, "IsAutomationFunction2": { "type": "boolean" }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FingerprintDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FingerprintDto" } }, "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 }, "FirmwareDeploymentV2": { "type": "object", "properties": { "Candidate": { "$ref": "#/components/schemas/CandidateFwDto" }, "Current": { "$ref": "#/components/schemas/CurrentFwDto" }, "Id": { "type": "string", "nullable": true }, "ProductType": { "type": "string", "nullable": true }, "TotalDevices": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FirmwareDeploymentV2SingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/FirmwareDeploymentV2" } }, "additionalProperties": false }, "FirmwareUpdateSettingDto": { "type": "object", "properties": { "Enabled": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "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 }, "GroupDto": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "MemberCount": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "Company": { "$ref": "#/components/schemas/Int32IdName" }, "CompanyName": { "type": "string", "nullable": true, "readOnly": true } }, "additionalProperties": false }, "GroupDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDto" }, "nullable": true } }, "additionalProperties": false }, "GroupDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GroupDto" } }, "additionalProperties": false }, "GroupDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GroupDto" }, "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 }, "GuidIdName": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "GuidIdNameSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/GuidIdName" } }, "additionalProperties": false }, "GuidSearchResultItemDto": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Pattern": { "type": "string", "nullable": true }, "Properties": { "type": "array", "items": { "$ref": "#/components/schemas/LabelValueDto" }, "nullable": true }, "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true } }, "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 }, "HolidayDto": { "type": "object", "properties": { "Localization": { "$ref": "#/components/schemas/LanguageV2" }, "IsRepeatable": { "type": "boolean" }, "Date": { "type": "string", "format": "date-time" }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "HolidayDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/HolidayDto" }, "nullable": true } }, "additionalProperties": false }, "HolidayDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/HolidayDto" } }, "additionalProperties": false }, "HttpSettingDto": { "type": "object", "properties": { "BaseAddress": { "type": "string", "format": "uri", "nullable": true }, "IsBaseAddressAutoDetected": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "HttpSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/HttpSettingDto" } }, "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 }, "IncompatibleFirmwareV2": { "type": "object", "properties": { "FwVersion": { "type": "string", "nullable": true }, "ProductGroup": { "type": "string", "nullable": true }, "IsAccepted": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "IncompatibleFirmwareV2V2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IncompatibleFirmwareV2" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Int32IdName": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Int32IdNameSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/Int32IdName" } }, "additionalProperties": false }, "Int32SearchResultItemDto": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Pattern": { "type": "string", "nullable": true }, "Properties": { "type": "array", "items": { "$ref": "#/components/schemas/LabelValueDto" }, "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "IntId": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Interval": { "type": "object", "properties": { "From": { "type": "string", "format": "date-span" }, "To": { "type": "string", "format": "date-span" } }, "additionalProperties": false }, "IntervalDto": { "type": "object", "properties": { "DayOfWeek": { "type": "integer", "format": "int32" }, "Enabled": { "type": "boolean" }, "From": { "type": "string", "nullable": true }, "To": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IntervalDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/IntervalDto" } }, "additionalProperties": false }, "IntervalDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/IntervalDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "IssueType": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "type": "integer", "description": "<ul><li>0 - <i>NoDeviceInArea</i></li>\n<li>1 - <i>NoInputDefined</i></li>\n<li>2 - <i>DeviceIsMisconfigured</i></li>\n<li>3 - <i>DeviceIsEnterOfAnotherArea</i></li>\n<li>4 - <i>DeviceHasInsufficientLicense</i></li>\n<li>5 - <i>DeviceDisabled</i></li>\n<li>6 - <i>DeviceDisconnected</i></li>\n<li>7 - <i>DeviceHasIncompatibleVersion</i></li>\n<li>8 - <i>DeviceHasRexButton</i></li>\n<li>9 - <i>DeviceIncompatibleWithHardOccupancyLimit</i></li>\n</ul>", "format": "int32" }, "JobStates": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "<ul><li>0 - <i>Unknown</i></li>\n<li>1 - <i>InProgress</i></li>\n<li>2 - <i>Successful</i></li>\n<li>3 - <i>Failed</i></li>\n</ul>", "format": "int32" }, "JobStatus": { "type": "object", "properties": { "Timestamp": { "type": "string", "format": "date-time", "nullable": true }, "State": { "enum": [ "Unknown", "InProgress", "Successful", "Failed" ], "type": "string" } }, "additionalProperties": false }, "JobStatusDto": { "type": "object", "properties": { "When": { "type": "string", "format": "date-time", "nullable": true }, "State": { "$ref": "#/components/schemas/JobStates" } }, "additionalProperties": false }, "JobStatusDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/JobStatusDto" } }, "additionalProperties": false }, "LabelValueDto": { "type": "object", "properties": { "Label": { "type": "string", "nullable": true }, "Value": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LanguageV2": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "<ul><li>0 - <i>Unknown</i></li>\n<li>1 - <i>En</i></li>\n<li>2 - <i>Cs</i></li>\n<li>3 - <i>De</i></li>\n<li>4 - <i>It</i></li>\n<li>5 - <i>Ru</i></li>\n<li>6 - <i>Es</i></li>\n<li>7 - <i>Fr</i></li>\n</ul>", "format": "int32" }, "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 }, "LdapFieldsV2Dto": { "type": "object", "properties": { "NextSync": { "type": "string", "format": "date-time", "nullable": true }, "SyncFields": { "$ref": "#/components/schemas/SynchronizedFields" } }, "additionalProperties": false }, "LdapFieldsV2DtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LdapFieldsV2Dto" } }, "additionalProperties": false }, "LdapGroupMap": { "type": "object", "properties": { "GroupNameAttribute": { "type": "string", "nullable": true }, "GroupMemberAttribute": { "type": "string", "nullable": true } }, "additionalProperties": false }, "LdapSettingDto": { "required": [ "BaseDN", "Host", "Password", "Username" ], "type": "object", "properties": { "Enabled": { "type": "boolean" }, "Host": { "minLength": 1, "type": "string" }, "Port": { "type": "integer", "format": "int32" }, "Username": { "minLength": 1, "type": "string" }, "Password": { "minLength": 1, "type": "string" }, "BaseDN": { "minLength": 1, "type": "string" }, "AdditionalUserDN": { "type": "string", "nullable": true }, "AdditionalGroupDN": { "type": "string", "nullable": true }, "UseSSL": { "type": "boolean" }, "UserFilter": { "type": "string", "nullable": true }, "FieldMapping": { "$ref": "#/components/schemas/LdapFieldMap" }, "NestedSearch": { "type": "boolean" }, "ImportAvatar": { "type": "boolean" }, "RemovedSyncUsers": { "$ref": "#/components/schemas/RemovedSyncUsers" }, "SyncDisabledFlag": { "type": "boolean" }, "FollowReferral": { "type": "boolean" }, "PageSize": { "maximum": 2147483647, "minimum": 0, "type": "integer", "format": "int32" }, "SyncGroups": { "type": "boolean" }, "GroupFilter": { "type": "string", "nullable": true }, "GroupMapping": { "$ref": "#/components/schemas/LdapGroupMap" }, "NestedGroups": { "type": "boolean" }, "SynchronizeFrom": { "type": "string", "format": "date-span" }, "LastSyncTime": { "type": "string", "format": "date-time", "nullable": true }, "NextSyncTime": { "type": "string", "format": "date-time", "nullable": true }, "LastSyncSuccess": { "type": "boolean" }, "Interval": { "type": "integer", "format": "int32" }, "DayOfWeek": { "type": "integer", "format": "int32" }, "UserBaseDN": { "type": "string", "nullable": true, "readOnly": true }, "GroupBaseDN": { "type": "string", "nullable": true, "readOnly": true }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Id": { "type": "integer", "format": "int32" }, "IsPaginationEnabled": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "LdapSettingDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LdapSettingDto" }, "nullable": true } }, "additionalProperties": false }, "LdapSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LdapSettingDto" } }, "additionalProperties": false }, "LicenseAgreementSettingDto": { "type": "object", "properties": { "ShowLicenseAgreement": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LicenseAgreementSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LicenseAgreementSettingDto" } }, "additionalProperties": false }, "LicenseFeaturesDto": { "type": "object", "properties": { "Tier": { "type": "string", "nullable": true }, "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" }, "Synchronization": { "type": "boolean" }, "Attendance": { "type": "boolean" }, "FirmwareUpdate": { "type": "boolean" }, "Visitors": { "type": "boolean" }, "Antipassback": { "type": "boolean" }, "PersonalizedDashboard": { "type": "boolean" }, "Lockdown": { "type": "boolean" }, "InstallationId": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "LicenseFeaturesDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LicenseFeaturesDto" } }, "additionalProperties": false }, "LicenseInfoDto": { "type": "object", "properties": { "LicenseDeviceSN": { "type": "string", "nullable": true }, "Uploaded": { "type": "string", "format": "date-time", "nullable": true }, "Expiration": { "type": "string", "nullable": true }, "MaxUsers": { "type": "integer", "format": "int32" }, "AvailableUsers": { "type": "integer", "format": "int32" }, "MaxDevices": { "type": "integer", "format": "int32" }, "AvailableDevices": { "type": "integer", "format": "int32" }, "MaxManagers": { "type": "integer", "format": "int32" }, "AvailableManagers": { "type": "integer", "format": "int32" }, "LicenseTier": { "type": "string", "nullable": true }, "HasAttendance": { "type": "boolean" } }, "additionalProperties": false }, "LicenseInfoDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LicenseInfoDto" } }, "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 }, "LiftFloorDto": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "PublicAccess": { "type": "boolean" }, "PublicAccessProfile": { "$ref": "#/components/schemas/GuidIdName" }, "Zone": { "$ref": "#/components/schemas/GuidIdName" }, "Enabled": { "type": "boolean", "readOnly": true } }, "additionalProperties": false }, "LiftFloorDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/LiftFloorDto" }, "nullable": true } }, "additionalProperties": false }, "LiftFloorDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LiftFloorDto" } }, "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 }, "LockdownStateDto": { "type": "object", "properties": { "State": { "$ref": "#/components/schemas/States" }, "IsActive": { "type": "boolean" }, "Confirmed": { "type": "boolean" }, "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 }, "LogSnapshotDto": { "type": "object", "properties": { "IsAvailable": { "type": "boolean" }, "Timestamp": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "LoginDataV2": { "required": [ "login", "password" ], "type": "object", "properties": { "login": { "minLength": 1, "type": "string" }, "password": { "minLength": 1, "type": "string" }, "longTimeLogin": { "type": "boolean" } }, "additionalProperties": false }, "LoginInfoDto": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Login": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "AvatarUrl": { "type": "string", "nullable": true }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Localization": { "$ref": "#/components/schemas/LanguageV2" }, "ShowWizard": { "type": "boolean" }, "ShowGiveFeedback": { "type": "boolean" }, "AttendanceMonitored": { "type": "boolean" }, "IsSysAdmin": { "type": "boolean" }, "Right": { "$ref": "#/components/schemas/RolesV2" }, "Company": { "$ref": "#/components/schemas/Int32IdName" } }, "additionalProperties": false }, "LoginInfoDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/LoginInfoDto" } }, "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 }, "MailerSettingDto": { "required": [ "DefaultAddressFrom", "Host" ], "type": "object", "properties": { "Host": { "minLength": 1, "type": "string" }, "HostUserName": { "type": "string", "nullable": true }, "HostPassword": { "type": "string", "nullable": true }, "DefaultAddressFrom": { "minLength": 1, "type": "string", "format": "email" }, "Enabled": { "type": "boolean" }, "Ssl": { "type": "boolean" }, "ValidateCertificate": { "type": "boolean" }, "UseLegacyMode": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Port": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MailerSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MailerSettingDto" } }, "additionalProperties": false }, "MobileEncryptionKeyDtoV2": { "type": "object", "properties": { "Ordinal": { "type": "integer", "format": "int32" }, "KeyId": { "type": "string", "nullable": true }, "Modified": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "MobileEncryptionKeyDtoV2ArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MobileEncryptionKeyDtoV2" }, "nullable": true } }, "additionalProperties": false }, "MobileKeyCredentialsV2": { "type": "object", "properties": { "Pin": { "type": "integer", "format": "int32" }, "AuthId": { "type": "string", "nullable": true }, "Location": { "type": "string", "nullable": true }, "KeyId": { "type": "string", "nullable": true }, "PubKey": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MobileKeyCredentialsV2SingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MobileKeyCredentialsV2" } }, "additionalProperties": false }, "MobileKeyDonglePairing": { "type": "object", "properties": { "AuthId": { "type": "string", "nullable": true }, "State": { "enum": [ "unknown", "inactive", "pending", "expired", "paired", "error" ], "type": "string" } }, "additionalProperties": false }, "MobileKeySettingsDto": { "type": "object", "properties": { "UseDongle": { "type": "boolean" }, "Keys": { "type": "array", "items": { "$ref": "#/components/schemas/MobileEncryptionKeyDtoV2" }, "nullable": true }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "MobileKeySettingsDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/MobileKeySettingsDto" } }, "additionalProperties": false }, "Mode": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "<ul><li>0 - <i>None</i></li>\n<li>1 - <i>Soft</i></li>\n<li>2 - <i>Hard</i></li>\n</ul>", "format": "int32" }, "MonitorSettings": { "type": "object", "properties": { "selectedDevices": { "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "columns": { "type": "array", "items": { "$ref": "#/components/schemas/ColumnItem" }, "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 }, "NetworkSettingsSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NetworkSettings" } }, "additionalProperties": false }, "NotificationDto": { "type": "object", "properties": { "Channels": { "$ref": "#/components/schemas/Channels" }, "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 }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "MonitorAllDevices": { "type": "boolean" }, "MonitoredDevices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "Name": { "type": "string", "nullable": true }, "Recipients": { "$ref": "#/components/schemas/Recipients" } }, "additionalProperties": false }, "NotificationDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/NotificationDto" } }, "additionalProperties": false }, "NotificationDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "NotificationEventArraySingleResult": { "type": "object", "properties": { "data": { "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 } }, "additionalProperties": false }, "PairingSetting": { "type": "object", "properties": { "NoPairingDeviceIsActive": { "type": "boolean" }, "AvailableDevices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "ValidityPeriod": { "type": "integer", "format": "int32" }, "UseDongle": { "type": "boolean" } }, "additionalProperties": false }, "PasswordChange": { "type": "object", "properties": { "OldPassword": { "type": "string", "nullable": true }, "NewPassword": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PasswordChangeSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PasswordChange" } }, "additionalProperties": false }, "PasswordResetCodeData": { "required": [ "Code" ], "type": "object", "properties": { "Code": { "maxLength": 16, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "PasswordResetData": { "required": [ "Login" ], "type": "object", "properties": { "Login": { "maxLength": 64, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "PasswordSetRequest": { "required": [ "NewPassword", "Token" ], "type": "object", "properties": { "Token": { "maxLength": 40, "minLength": 1, "type": "string" }, "NewPassword": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "PasswordTokenDto": { "type": "object", "properties": { "Token": { "type": "string", "nullable": true } }, "additionalProperties": false }, "PasswordTokenDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PasswordTokenDto" } }, "additionalProperties": false }, "PeriodicBackupSettingV2": { "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 }, "Time": { "type": "string", "format": "date-span" }, "DayOfMonth": { "maximum": 31, "minimum": 1, "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PeriodicBackupSettingV2SingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PeriodicBackupSettingV2" } }, "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 }, "PhoneNumberDto": { "type": "object", "properties": { "Ordinal": { "type": "integer", "format": "int32" }, "Number": { "type": "string", "nullable": true }, "TimeProfile": { "$ref": "#/components/schemas/TimeProfileDto" }, "GroupCall": { "type": "boolean" }, "StationName": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PhoneNumberDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PhoneNumberDto" } }, "additionalProperties": false }, "PicardReadKeys": { "required": [ "Aid", "AuthKey", "DecipherKey", "ReadKey", "VerificationKey" ], "type": "object", "properties": { "Aid": { "type": "string", "format": "byte" }, "AuthKey": { "type": "string", "format": "byte" }, "ReadKey": { "type": "string", "format": "byte" }, "DecipherKey": { "type": "string", "format": "byte" }, "VerificationKey": { "type": "string", "format": "byte" } }, "additionalProperties": false }, "PresenceDto": { "type": "object", "properties": { "IsSpecifyingDirection": { "type": "boolean" }, "Present": { "type": "array", "items": { "$ref": "#/components/schemas/PresentPersonV2" }, "nullable": true } }, "additionalProperties": false }, "PresenceDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PresenceDto" } }, "additionalProperties": false }, "PresencePayloadV2": { "type": "object", "properties": { "Action": { "enum": [ "Add", "Remove", "Update" ], "type": "string" }, "UserId": { "type": "string", "nullable": true }, "Person": { "$ref": "#/components/schemas/PresentPersonV2" } }, "additionalProperties": false }, "PresenceSettingDto": { "type": "object", "properties": { "HoursBack": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "PresenceSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/PresenceSettingDto" } }, "additionalProperties": false }, "PresentPersonV2": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "Email": { "type": "string", "nullable": true }, "CompanyId": { "type": "integer", "format": "int32", "nullable": true }, "CompanyName": { "type": "string", "nullable": true }, "GroupNames": { "type": "string", "nullable": true }, "GroupIds": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "PhoneNumber": { "type": "string", "nullable": true }, "Time": { "type": "string", "nullable": true }, "DeviceName": { "type": "string", "nullable": true }, "ZoneId": { "type": "string", "format": "uuid" }, "ZoneName": { "type": "string", "nullable": true }, "IsExit": { "type": "boolean" } }, "additionalProperties": false }, "ProfileIdDto": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" } }, "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 }, "ProxySettingSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ProxySetting" } }, "additionalProperties": false }, "ReadersSettingDto": { "type": "object", "properties": { "Rfid125kEnabled": { "type": "boolean" }, "Rfid13M56Enabled": { "type": "boolean" }, "FingerprintEnabled": { "type": "boolean" }, "BluetoothEnabled": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ReadersSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ReadersSettingDto" } }, "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 }, "RecipientsDto": { "type": "object", "properties": { "Users": { "type": "array", "items": { "type": "string", "format": "uuid" }, "nullable": true }, "External": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ReducedDeviceDto": { "type": "object", "properties": { "IPAddress": { "type": "string", "nullable": true }, "SerialNumber": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReducedDeviceDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ReducedDeviceDto" }, "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 }, "RelayV2": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "<ul><li>0 - <i>False</i></li>\n<li>1 - <i>True</i></li>\n<li>2 - <i>Unknown</i></li>\n</ul>", "format": "int32" }, "RelayV2StateOfDto": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/RelayV2" }, "Time": { "type": "string", "format": "date-time", "nullable": true }, "FailureReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReleaseNotes": { "type": "object", "properties": { "Version": { "type": "string", "nullable": true }, "Text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ReleaseNotesSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ReleaseNotes" } }, "additionalProperties": false }, "RemovedSyncUsers": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "<ul><li>0 - <i>Unchanged</i></li>\n<li>1 - <i>Disabled</i></li>\n<li>2 - <i>Deleted</i></li>\n</ul>", "format": "int32" }, "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 }, "RolesV2": { "type": "object", "properties": { "VisitorCompanies": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "ManagedDoors": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "nullable": true }, "Groups": { "uniqueItems": true, "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 }, "RolesV2SingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/RolesV2" } }, "additionalProperties": false }, "SearchResultAccessLogV2Dto": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32SearchResultItemDto" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/GuidSearchResultItemDto" }, "nullable": true }, "visitors": { "type": "array", "items": { "$ref": "#/components/schemas/GuidSearchResultItemDto" }, "nullable": true }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/GuidSearchResultItemDto" }, "nullable": true }, "companies": { "type": "array", "items": { "$ref": "#/components/schemas/Int32SearchResultItemDto" }, "nullable": true } }, "additionalProperties": false }, "SearchResultAccessLogV2DtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SearchResultAccessLogV2Dto" } }, "additionalProperties": false }, "SearchResultLockdownItemDto": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Type": { "type": "string", "nullable": true }, "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/IdName" }, "nullable": true } }, "additionalProperties": false }, "SearchResultLockdownV2Dto": { "type": "object", "properties": { "lockdownables": { "type": "array", "items": { "$ref": "#/components/schemas/SearchResultLockdownItemDto" }, "nullable": true } }, "additionalProperties": false }, "SearchResultLockdownV2DtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SearchResultLockdownV2Dto" } }, "additionalProperties": false }, "SearchResultSystemLogV2Dto": { "type": "object", "properties": { "subjects": { "type": "array", "items": { "$ref": "#/components/schemas/GuidSearchResultItemDto" }, "nullable": true } }, "additionalProperties": false }, "SearchResultSystemLogV2DtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SearchResultSystemLogV2Dto" } }, "additionalProperties": false }, "SearchResultV2Dto": { "type": "object", "properties": { "devices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32SearchResultItemDto" }, "nullable": true }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/GuidSearchResultItemDto" }, "nullable": true }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/GuidSearchResultItemDto" }, "nullable": true }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/GuidSearchResultItemDto" }, "nullable": true }, "visitors": { "type": "array", "items": { "$ref": "#/components/schemas/GuidSearchResultItemDto" }, "nullable": true }, "visitorCards": { "type": "array", "items": { "$ref": "#/components/schemas/Int32SearchResultItemDto" }, "nullable": true } }, "additionalProperties": false }, "SearchResultV2DtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SearchResultV2Dto" } }, "additionalProperties": false }, "SecureCardKeyInfo": { "type": "object", "properties": { "Description": { "type": "string", "nullable": true }, "Hash": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SecureCardKeyInfoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SecureCardKeyInfo" } }, "additionalProperties": false }, "SecureCardKeys": { "required": [ "Description", "Picard" ], "type": "object", "properties": { "Description": { "minLength": 1, "type": "string" }, "Picard": { "$ref": "#/components/schemas/PicardReadKeys" } }, "additionalProperties": false }, "SecureCardKeysImport": { "required": [ "Payload" ], "type": "object", "properties": { "Password": { "type": "string", "nullable": true }, "Payload": { "type": "string", "format": "byte" } }, "additionalProperties": false }, "SecureCardKeysSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SecureCardKeys" } }, "additionalProperties": false }, "SendPairingMailDto": { "type": "object", "properties": { "Email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ShortMemberDto": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "IsVisitor": { "type": "boolean" } }, "additionalProperties": false }, "ShortMemberDtoArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ShortMemberDto" }, "nullable": true } }, "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 }, "SipRegistrationV2": { "enum": [ 0, 1, 2, 3, 4, 5 ], "type": "integer", "description": "<ul><li>0 - <i>Unregistered</i></li>\n<li>1 - <i>Registering</i></li>\n<li>2 - <i>Registered</i></li>\n<li>3 - <i>Unregistering</i></li>\n<li>4 - <i>Error</i></li>\n<li>5 - <i>Unknown</i></li>\n</ul>", "format": "int32" }, "SipRegistrationV2StateOfDto": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/SipRegistrationV2" }, "Time": { "type": "string", "format": "date-time", "nullable": true }, "FailureReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "SmtpStatusDto": { "type": "object", "properties": { "Enabled": { "type": "boolean" } }, "additionalProperties": false }, "SmtpStatusDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SmtpStatusDto" } }, "additionalProperties": false }, "Snapshot": { "type": "object", "properties": { "Timestamp": { "type": "string", "format": "date-time" }, "ImageUrl": { "type": "string", "format": "uri", "nullable": true } }, "additionalProperties": false }, "SnapshotArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Snapshot" }, "nullable": true } }, "additionalProperties": false }, "SshServiceState": { "type": "object", "properties": { "Enabled": { "type": "boolean" } }, "additionalProperties": false }, "SshServiceStateSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SshServiceState" } }, "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 }, "States": { "enum": [ 0, 1, 2, 3 ], "type": "integer", "description": "<ul><li>0 - <i>Unknown</i></li>\n<li>1 - <i>Normal</i></li>\n<li>2 - <i>Lockdown</i></li>\n<li>3 - <i>PartialLockdown</i></li>\n</ul>", "format": "int32" }, "StatisticsSettingDto": { "type": "object", "properties": { "StatisticsEnabled": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "StatisticsSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/StatisticsSettingDto" } }, "additionalProperties": false }, "StatusDto": { "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "<ul><li>0 - <i>Unknown</i></li>\n<li>1 - <i>CertificateInvalid</i></li>\n<li>2 - <i>Inaccessible</i></li>\n<li>3 - <i>LoginFailed</i></li>\n<li>4 - <i>Active</i></li>\n<li>5 - <i>Disabled</i></li>\n<li>6 - <i>Incompatible</i></li>\n</ul>", "format": "int32" }, "SwitchActivationRequestDto": { "type": "object", "properties": { "Action": { "enum": [ "On", "Off", "Trigger", "Lock", "Unlock", "Hold", "Release" ], "type": "string" } }, "additionalProperties": false }, "SwitchCapabilityDto": { "type": "object", "properties": { "switch": { "type": "integer", "format": "int32" }, "enabled": { "type": "boolean" }, "mode": { "$ref": "#/components/schemas/SwitchMode" }, "switchOnDuration": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/SwitchType" } }, "additionalProperties": false }, "SwitchCapabilityDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SwitchCapabilityDto" } }, "additionalProperties": false }, "SwitchMode": { "enum": [ 0, 1 ], "type": "integer", "description": "<ul><li>0 - <i>monostable</i></li>\n<li>1 - <i>bistable</i></li>\n</ul>", "format": "int32" }, "SwitchType": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "<ul><li>0 - <i>normal</i></li>\n<li>1 - <i>security</i></li>\n<li>2 - <i>inverted</i></li>\n</ul>", "format": "int32" }, "SynchronizationSettingDto": { "type": "object", "properties": { "Address": { "type": "string", "nullable": true }, "Username": { "type": "string", "nullable": true }, "Password": { "type": "string", "nullable": true }, "Enabled": { "type": "boolean" }, "OnlySecure": { "type": "boolean" }, "SynchronizeFrom": { "type": "string", "format": "date-span" }, "Interval": { "type": "integer", "format": "int32" }, "DayOfWeek": { "type": "integer", "format": "int32" }, "LastSyncTime": { "type": "string", "format": "date-time", "nullable": true }, "NextSyncTime": { "type": "string", "format": "date-time", "nullable": true }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SynchronizationSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SynchronizationSettingDto" } }, "additionalProperties": false }, "SynchronizationStateDto": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "IsSynchronizing": { "type": "boolean" } }, "additionalProperties": false }, "SynchronizationStateDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SynchronizationStateDto" } }, "additionalProperties": false }, "SynchronizationStatusDtoV2": { "type": "object", "properties": { "LastSyncTime": { "type": "string", "format": "date-time", "nullable": true }, "NextSyncTime": { "type": "string", "format": "date-time", "nullable": true }, "SyncState": { "$ref": "#/components/schemas/SynchronizationStatusV2" } }, "additionalProperties": false }, "SynchronizationStatusDtoV2SingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SynchronizationStatusDtoV2" } }, "additionalProperties": false }, "SynchronizationStatusV2": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "<ul><li>0 - <i>Unknown</i></li>\n<li>1 - <i>InProgress</i></li>\n<li>2 - <i>Successful</i></li>\n<li>3 - <i>Failed</i></li>\n<li>4 - <i>WithErrors</i></li>\n</ul>", "format": "int32" }, "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 }, "SystemInfoDto": { "type": "object", "properties": { "DateTime": { "$ref": "#/components/schemas/SystemTime" } }, "additionalProperties": false }, "SystemInfoDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SystemInfoDto" } }, "additionalProperties": false }, "SystemLogAuthorDtoV2": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": 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 }, "SystemLogDataV2QueryResult": { "type": "object", "properties": { "data": { "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 }, "SystemLogDtoV2": { "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/SystemLogSubjectDtoV2" }, "Event": { "type": "string", "nullable": true }, "NotificationEvent": { "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/SystemLogAuthorDtoV2" }, "Detail": { "type": "string", "nullable": true }, "Snapshot": { "$ref": "#/components/schemas/LogSnapshotDto" }, "CreatedTimestamp": { "type": "string", "nullable": true }, "NotificationTriggered": { "type": "boolean" } }, "additionalProperties": false }, "SystemLogSubjectDtoV2": { "type": "object", "properties": { "Type": { "type": "string", "nullable": true }, "Id": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true } }, "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" }, "SystemUpdateStepV2": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/SystemUpdateStatus" }, "Date": { "type": "string", "format": "date-time" }, "Version": { "type": "string", "nullable": true }, "ReleaseNotes": { "type": "array", "items": { "$ref": "#/components/schemas/ReleaseNotes" }, "nullable": true }, "Progress": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "SystemUpdateStepV2SingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/SystemUpdateStepV2" } }, "additionalProperties": false }, "TemplatesDto": { "type": "object", "properties": { "VisitorPin": { "$ref": "#/components/schemas/EmailTemplate" }, "VisitorQrCode": { "$ref": "#/components/schemas/EmailTemplate" }, "UserPin": { "$ref": "#/components/schemas/EmailTemplate" }, "UserQrCode": { "$ref": "#/components/schemas/EmailTemplate" }, "UserMobileKey": { "$ref": "#/components/schemas/EmailTemplate" } }, "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 }, "TimeProfileDto": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "Name": { "type": "string", "nullable": true }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Ordinal": { "type": "integer", "format": "int32", "nullable": true }, "Days": { "type": "array", "items": { "$ref": "#/components/schemas/DayOfWeekDto" }, "nullable": true, "readOnly": true }, "Intervals": { "type": "array", "items": { "$ref": "#/components/schemas/IntervalDto" }, "nullable": true, "readOnly": true } }, "additionalProperties": false }, "TimeProfileDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/TimeProfileDto" } }, "additionalProperties": false }, "TimeProfileDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimeProfileDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TimeZoneId": { "type": "object", "properties": { "Id": { "type": "string", "nullable": true } }, "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 }, "TopicDescriptionArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TopicDescription" }, "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 }, "TriggerV2": { "enum": [ 0, 1 ], "type": "integer", "description": "<ul><li>0 - <i>Out</i></li>\n<li>1 - <i>In</i></li>\n</ul>", "format": "int32" }, "TriggerV2StateOfDto": { "type": "object", "properties": { "Status": { "$ref": "#/components/schemas/TriggerV2" }, "Time": { "type": "string", "format": "date-time", "nullable": true }, "FailureReason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Uid": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" } }, "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 }, "UserBulkRestrictedAccess": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "RestrictedAccess": { "$ref": "#/components/schemas/AccessRestriction" } }, "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 }, "UserDto": { "type": "object", "properties": { "Company": { "$ref": "#/components/schemas/Int32IdName" }, "Groups": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "ValidFrom": { "type": "string", "format": "date-time" }, "ValidTo": { "type": "string", "format": "date-time" }, "Cards": { "type": "array", "items": { "$ref": "#/components/schemas/CardDto" }, "nullable": true }, "Zones": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "IsEnabled": { "type": "boolean" }, "Email": { "type": "string", "nullable": true }, "AvatarUrl": { "type": "string", "nullable": true }, "VirtualNumber": { "type": "string", "nullable": true }, "Note": { "type": "string", "nullable": true }, "PhoneNumbers": { "type": "array", "items": { "$ref": "#/components/schemas/PhoneNumberDto" }, "nullable": true }, "Fingerprints": { "type": "array", "items": { "$ref": "#/components/schemas/FingerprintDto" }, "nullable": true }, "Codes": { "type": "array", "items": { "$ref": "#/components/schemas/CodeDto" }, "nullable": true }, "VirtualCard": { "type": "string", "nullable": true }, "LicensePlates": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "nullable": true }, "Pin": { "type": "string", "nullable": true }, "QrCode": { "type": "string", "nullable": true }, "PinCollisions": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true }, "Deputy": { "$ref": "#/components/schemas/GuidIdName" }, "Login": { "type": "string", "nullable": true }, "IsAttendanceMonitoring": { "type": "boolean" }, "EmployeeID": { "type": "string", "nullable": true }, "Settings": { "$ref": "#/components/schemas/UserSettingDto" }, "IsSysAdmin": { "type": "boolean" }, "IsVisitor": { "type": "boolean" }, "Type": { "type": "string", "nullable": true }, "Name": { "type": "string", "nullable": true }, "Id": { "type": "string", "format": "uuid" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "CompanyName": { "type": "string", "nullable": true, "readOnly": true }, "PhoneNumberList": { "type": "string", "nullable": true, "readOnly": true }, "RestrictedAccess": { "$ref": "#/components/schemas/AccessRestriction" } }, "additionalProperties": false }, "UserDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserDto" } }, "additionalProperties": false }, "UserDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserId": { "type": "object", "properties": { "Id": { "type": "string", "format": "uuid" } }, "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 }, "UserPairing": { "type": "object", "properties": { "State": { "enum": [ "unknown", "inactive", "pending", "expired", "paired", "error" ], "type": "string" }, "PairingTimeUntil": { "type": "string", "format": "date-time", "nullable": true }, "PairingType": { "enum": [ "dongle", "device" ], "type": "string" }, "Pin": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserPairingStatus": { "type": "object", "properties": { "AuthId": { "type": "string", "nullable": true }, "Pairing": { "$ref": "#/components/schemas/UserPairing" }, "Settings": { "$ref": "#/components/schemas/PairingSetting" } }, "additionalProperties": false }, "UserPairingStatusSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserPairingStatus" } }, "additionalProperties": false }, "UserSettingDto": { "type": "object", "properties": { "Id": { "type": "integer", "format": "int32" }, "PasswordMustBeChanged": { "type": "boolean", "nullable": true }, "FromExternalSystem": { "type": "boolean", "nullable": true }, "ShowWizard": { "type": "boolean", "nullable": true }, "ShowGiveFeedback": { "type": "boolean", "nullable": true }, "Localization": { "$ref": "#/components/schemas/LanguageV2" }, "MonitorSettings": { "$ref": "#/components/schemas/MonitorSettings" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserSettingDto" } }, "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 }, "UserVirtualNumberArraySingleResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserVirtualNumber" }, "nullable": true } }, "additionalProperties": false }, "UserVirtualNumberDto": { "type": "object", "properties": { "User": { "$ref": "#/components/schemas/GuidIdName" }, "VirtualNumber": { "type": "string", "nullable": true }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Id": { "type": "integer", "format": "int32", "readOnly": true } }, "additionalProperties": false }, "UserVirtualNumberSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/UserVirtualNumber" } }, "additionalProperties": false }, "V2AttendanceExportRequest": { "type": "object", "properties": { "From": { "type": "string", "format": "date-time" }, "To": { "type": "string", "format": "date-time" }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/UserDto" }, "nullable": true } }, "additionalProperties": false }, "VerificationImageDto": { "type": "object", "properties": { "verificationImage": { "type": "string", "format": "byte", "nullable": true } }, "additionalProperties": false }, "VerificationImageDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/VerificationImageDto" } }, "additionalProperties": false }, "VisitorCardDto": { "required": [ "TagId" ], "type": "object", "properties": { "Company": { "$ref": "#/components/schemas/Int32IdName" }, "CompanyName": { "type": "string", "nullable": true }, "Id": { "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "Name": { "type": "string", "nullable": true }, "TagId": { "minLength": 1, "type": "string" }, "Visitor": { "$ref": "#/components/schemas/GuidIdName" }, "VisitorName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "VisitorCardDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/VisitorCardDto" } }, "additionalProperties": false }, "VisitorCardDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VisitorCardDto" }, "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" }, "VisitorV2Dto": { "required": [ "Company", "Name", "VisitTo" ], "type": "object", "properties": { "ModifiedGuid": { "type": "integer", "format": "int32" }, "Card": { "type": "string", "nullable": true }, "Pin": { "type": "string", "nullable": true }, "QrCode": { "type": "string", "nullable": true }, "LicensePlate": { "maxLength": 10, "type": "string", "nullable": true }, "PinCollisions": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true, "readOnly": true }, "VisitorCard": { "$ref": "#/components/schemas/VisitorCardDto" }, "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 }, "AvatarUrl": { "type": "string", "nullable": true, "readOnly": true }, "State": { "$ref": "#/components/schemas/VisitorState" } }, "additionalProperties": false }, "VisitorV2DtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/VisitorV2Dto" } }, "additionalProperties": false }, "VisitorV2DtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/VisitorV2Dto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VisitorsSettingDto": { "type": "object", "properties": { "VisitorRetentionDays": { "maximum": 365, "minimum": 0, "type": "integer", "format": "int32" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "VisitorsSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/VisitorsSettingDto" } }, "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 }, "ZoneData": { "type": "object", "properties": { "Name": { "type": "string", "nullable": true }, "Companies": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyDto" }, "nullable": true } }, "additionalProperties": false }, "ZoneDto": { "type": "object", "properties": { "CompaniesShortList": { "type": "string", "nullable": true }, "CompanyCount": { "type": "integer", "format": "int32" }, "DeviceCount": { "type": "integer", "format": "int32" }, "HasLicensePlateAuthentication": { "type": "boolean" }, "HasLimitFailedAccess": { "type": "boolean" }, "HasSilentAlarm": { "type": "boolean" }, "Id": { "type": "string", "format": "uuid" }, "IsCardAuthentication": { "type": "boolean" }, "IsCodeAuthentication": { "type": "boolean" }, "IsFingerprintAuthentication": { "type": "boolean" }, "IsMobileKeyAuthentication": { "type": "boolean" }, "Lockdown": { "$ref": "#/components/schemas/LockdownStateDto" }, "ModifiedGuid": { "type": "integer", "format": "int32" }, "MultiAuthOnlyEntry": { "type": "boolean" }, "MultiAuthTimeProfile": { "$ref": "#/components/schemas/GuidIdName" }, "Name": { "type": "string", "nullable": true }, "ZonalCode": { "type": "string", "nullable": true }, "Problems": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneProblemDto" }, "nullable": true } }, "additionalProperties": false }, "ZoneDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ZoneDto" } }, "additionalProperties": false }, "ZoneDtoV2QueryResult": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ZoneDto" }, "nullable": true }, "offset": { "type": "integer", "format": "int32" }, "limit": { "type": "integer", "format": "int32" }, "count": { "type": "integer", "format": "int32" } }, "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 }, "ZoneProblemDto": { "type": "object", "properties": { "Type": { "$ref": "#/components/schemas/ZoneProblemType" }, "Devices": { "type": "array", "items": { "$ref": "#/components/schemas/Int32IdName" }, "nullable": true }, "Users": { "type": "array", "items": { "$ref": "#/components/schemas/GuidIdName" }, "nullable": true } }, "additionalProperties": false }, "ZoneProblemType": { "enum": [ 0, 1, 2, 3, 4, 5, 100 ], "type": "integer", "description": "<ul><li>0 - <i>NoDeviceInZone</i></li>\n<li>1 - <i>DeviceDoesNotSupportedSilentAlarm</i></li>\n<li>2 - <i>DeviceHasNoSilentAlarmLicense</i></li>\n<li>3 - <i>PinCodeCollision</i></li>\n<li>4 - <i>DeviceDoesNotSupportedLimitFailedAccess</i></li>\n<li>5 - <i>DeviceHasNotLimitFailedAccessLicense</i></li>\n<li>100 - <i>Other</i></li>\n</ul>", "format": "int32" }, "ZoneSettingDto": { "type": "object", "properties": { "AccessPointsEnabled": { "type": "boolean" }, "ModifiedGuid": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ZoneSettingDtoSingleResult": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/ZoneSettingDto" } }, "additionalProperties": false } } } }